@emilgroup/payment-sdk-node 1.21.1-beta.4 → 1.21.1-beta.6
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/dist/api/bank-transaction-api.d.ts +84 -28
- package/dist/api/bank-transaction-api.js +114 -22
- package/dist/models/bank-transaction-class-without-expand-properties.d.ts +14 -0
- 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/dist/models/unlinked-bank-transaction-response-class.d.ts +14 -0
- package/models/bank-transaction-class-without-expand-properties.ts +14 -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/models/unlinked-bank-transaction-response-class.ts +14 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -45,6 +45,7 @@ models/create-tenant-bank-account-response-class.ts
|
|
|
45
45
|
models/deactivate-payment-reminder-request-dto.ts
|
|
46
46
|
models/deactivate-payment-reminder-response-class.ts
|
|
47
47
|
models/deactivated-payment-reminder-class.ts
|
|
48
|
+
models/generate-invoice-match-suggestions-response-class.ts
|
|
48
49
|
models/get-bank-account-response-class.ts
|
|
49
50
|
models/get-bank-transactions-response-class.ts
|
|
50
51
|
models/get-payment-method-response-class.ts
|
|
@@ -64,6 +65,7 @@ models/initiate-stripe-payment-setup-request-dto.ts
|
|
|
64
65
|
models/initiate-stripe-payment-setup-response-class.ts
|
|
65
66
|
models/inline-response200.ts
|
|
66
67
|
models/inline-response503.ts
|
|
68
|
+
models/invoice-match-suggestion-class.ts
|
|
67
69
|
models/link-bank-transaction-request-dto-rest.ts
|
|
68
70
|
models/link-bank-transactions-response-class.ts
|
|
69
71
|
models/list-bank-accounts-response-class.ts
|
|
@@ -83,6 +85,7 @@ models/refund-item-class.ts
|
|
|
83
85
|
models/sepa-direct-dto.ts
|
|
84
86
|
models/set-primary-bank-account-request-dto-rest.ts
|
|
85
87
|
models/shared-transaction-class.ts
|
|
88
|
+
models/suggestion-generation-progress-class.ts
|
|
86
89
|
models/symphony-profile-limited-response-dto.ts
|
|
87
90
|
models/tenant-bank-account-class-without-expand-properties.ts
|
|
88
91
|
models/tenant-bank-account-class.ts
|
package/README.md
CHANGED
|
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
|
|
|
17
17
|
Navigate to the folder of your consuming project and run one of the following commands:
|
|
18
18
|
|
|
19
19
|
```
|
|
20
|
-
npm install @emilgroup/payment-sdk-node@1.21.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk-node@1.21.1-beta.6 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk-node@1.21.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk-node@1.21.1-beta.6
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
|
@@ -21,6 +21,8 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
21
21
|
// @ts-ignore
|
|
22
22
|
import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
|
|
23
23
|
// @ts-ignore
|
|
24
|
+
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
25
|
+
// @ts-ignore
|
|
24
26
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
25
27
|
// @ts-ignore
|
|
26
28
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
@@ -44,12 +46,57 @@ const FormData = require('form-data');
|
|
|
44
46
|
*/
|
|
45
47
|
export const BankTransactionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
46
48
|
return {
|
|
49
|
+
/**
|
|
50
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
51
|
+
* @summary Invoice Match Suggestion
|
|
52
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
53
|
+
* @param {string} [authorization] Bearer Token
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
generateInvoiceMatchSuggestion: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
58
|
+
// verify required parameter 'code' is not null or undefined
|
|
59
|
+
assertParamExists('generateInvoiceMatchSuggestion', 'code', code)
|
|
60
|
+
const localVarPath = `/paymentservice/v1/tenant/bank-transactions/{code}/generate-invoice-match-suggestion`
|
|
61
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
62
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
63
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
64
|
+
let baseOptions;
|
|
65
|
+
let baseAccessToken;
|
|
66
|
+
if (configuration) {
|
|
67
|
+
baseOptions = configuration.baseOptions;
|
|
68
|
+
baseAccessToken = configuration.accessToken;
|
|
69
|
+
}
|
|
70
|
+
|
|
71
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
72
|
+
const localVarHeaderParameter = {} as any;
|
|
73
|
+
const localVarQueryParameter = {} as any;
|
|
74
|
+
|
|
75
|
+
// authentication bearer required
|
|
76
|
+
// http bearer authentication required
|
|
77
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
78
|
+
|
|
79
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
80
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
81
|
+
}
|
|
82
|
+
|
|
83
|
+
|
|
84
|
+
|
|
85
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
86
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
87
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
88
|
+
|
|
89
|
+
return {
|
|
90
|
+
url: toPathString(localVarUrlObj),
|
|
91
|
+
options: localVarRequestOptions,
|
|
92
|
+
};
|
|
93
|
+
},
|
|
47
94
|
/**
|
|
48
95
|
* 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\"
|
|
49
96
|
* @summary Retrieve the bank transaction
|
|
50
97
|
* @param {string} code
|
|
51
98
|
* @param {string} [authorization] Bearer Token
|
|
52
|
-
* @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>
|
|
99
|
+
* @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>
|
|
53
100
|
* @param {*} [options] Override http request option.
|
|
54
101
|
* @throws {RequiredError}
|
|
55
102
|
*/
|
|
@@ -95,9 +142,9 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
95
142
|
};
|
|
96
143
|
},
|
|
97
144
|
/**
|
|
98
|
-
* This will import bank transactions from a
|
|
145
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
99
146
|
* @summary Create the bank transactions
|
|
100
|
-
* @param {any} file
|
|
147
|
+
* @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
|
|
101
148
|
* @param {string} [authorization] Bearer Token
|
|
102
149
|
* @param {*} [options] Override http request option.
|
|
103
150
|
* @throws {RequiredError}
|
|
@@ -202,11 +249,11 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
202
249
|
* 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\"
|
|
203
250
|
* @summary List bank transactions
|
|
204
251
|
* @param {string} [authorization] Bearer Token
|
|
205
|
-
* @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,
|
|
206
|
-
* @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,
|
|
252
|
+
* @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>
|
|
253
|
+
* @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>
|
|
207
254
|
* @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>
|
|
208
|
-
* @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,
|
|
209
|
-
* @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>
|
|
255
|
+
* @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>
|
|
256
|
+
* @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>
|
|
210
257
|
* @param {*} [options] Override http request option.
|
|
211
258
|
* @throws {RequiredError}
|
|
212
259
|
*/
|
|
@@ -325,12 +372,24 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
325
372
|
export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
326
373
|
const localVarAxiosParamCreator = BankTransactionApiAxiosParamCreator(configuration)
|
|
327
374
|
return {
|
|
375
|
+
/**
|
|
376
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
377
|
+
* @summary Invoice Match Suggestion
|
|
378
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
379
|
+
* @param {string} [authorization] Bearer Token
|
|
380
|
+
* @param {*} [options] Override http request option.
|
|
381
|
+
* @throws {RequiredError}
|
|
382
|
+
*/
|
|
383
|
+
async generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>> {
|
|
384
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateInvoiceMatchSuggestion(code, authorization, options);
|
|
385
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
386
|
+
},
|
|
328
387
|
/**
|
|
329
388
|
* 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\"
|
|
330
389
|
* @summary Retrieve the bank transaction
|
|
331
390
|
* @param {string} code
|
|
332
391
|
* @param {string} [authorization] Bearer Token
|
|
333
|
-
* @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>
|
|
392
|
+
* @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>
|
|
334
393
|
* @param {*} [options] Override http request option.
|
|
335
394
|
* @throws {RequiredError}
|
|
336
395
|
*/
|
|
@@ -339,9 +398,9 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
339
398
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
399
|
},
|
|
341
400
|
/**
|
|
342
|
-
* This will import bank transactions from a
|
|
401
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
343
402
|
* @summary Create the bank transactions
|
|
344
|
-
* @param {any} file
|
|
403
|
+
* @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
|
|
345
404
|
* @param {string} [authorization] Bearer Token
|
|
346
405
|
* @param {*} [options] Override http request option.
|
|
347
406
|
* @throws {RequiredError}
|
|
@@ -367,11 +426,11 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
367
426
|
* 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\"
|
|
368
427
|
* @summary List bank transactions
|
|
369
428
|
* @param {string} [authorization] Bearer Token
|
|
370
|
-
* @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,
|
|
371
|
-
* @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,
|
|
429
|
+
* @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>
|
|
430
|
+
* @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>
|
|
372
431
|
* @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>
|
|
373
|
-
* @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,
|
|
374
|
-
* @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>
|
|
432
|
+
* @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>
|
|
433
|
+
* @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>
|
|
375
434
|
* @param {*} [options] Override http request option.
|
|
376
435
|
* @throws {RequiredError}
|
|
377
436
|
*/
|
|
@@ -402,12 +461,23 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
402
461
|
export const BankTransactionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
403
462
|
const localVarFp = BankTransactionApiFp(configuration)
|
|
404
463
|
return {
|
|
464
|
+
/**
|
|
465
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
466
|
+
* @summary Invoice Match Suggestion
|
|
467
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
468
|
+
* @param {string} [authorization] Bearer Token
|
|
469
|
+
* @param {*} [options] Override http request option.
|
|
470
|
+
* @throws {RequiredError}
|
|
471
|
+
*/
|
|
472
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass> {
|
|
473
|
+
return localVarFp.generateInvoiceMatchSuggestion(code, authorization, options).then((request) => request(axios, basePath));
|
|
474
|
+
},
|
|
405
475
|
/**
|
|
406
476
|
* 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\"
|
|
407
477
|
* @summary Retrieve the bank transaction
|
|
408
478
|
* @param {string} code
|
|
409
479
|
* @param {string} [authorization] Bearer Token
|
|
410
|
-
* @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>
|
|
480
|
+
* @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>
|
|
411
481
|
* @param {*} [options] Override http request option.
|
|
412
482
|
* @throws {RequiredError}
|
|
413
483
|
*/
|
|
@@ -415,9 +485,9 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
415
485
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
416
486
|
},
|
|
417
487
|
/**
|
|
418
|
-
* This will import bank transactions from a
|
|
488
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
419
489
|
* @summary Create the bank transactions
|
|
420
|
-
* @param {any} file
|
|
490
|
+
* @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
|
|
421
491
|
* @param {string} [authorization] Bearer Token
|
|
422
492
|
* @param {*} [options] Override http request option.
|
|
423
493
|
* @throws {RequiredError}
|
|
@@ -441,11 +511,11 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
441
511
|
* 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\"
|
|
442
512
|
* @summary List bank transactions
|
|
443
513
|
* @param {string} [authorization] Bearer Token
|
|
444
|
-
* @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,
|
|
445
|
-
* @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,
|
|
514
|
+
* @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>
|
|
515
|
+
* @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>
|
|
446
516
|
* @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>
|
|
447
|
-
* @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,
|
|
448
|
-
* @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>
|
|
517
|
+
* @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>
|
|
518
|
+
* @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>
|
|
449
519
|
* @param {*} [options] Override http request option.
|
|
450
520
|
* @throws {RequiredError}
|
|
451
521
|
*/
|
|
@@ -467,6 +537,27 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
467
537
|
};
|
|
468
538
|
};
|
|
469
539
|
|
|
540
|
+
/**
|
|
541
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
542
|
+
* @export
|
|
543
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
544
|
+
*/
|
|
545
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
546
|
+
/**
|
|
547
|
+
* Code of the bank transaction to generate match suggestions for
|
|
548
|
+
* @type {string}
|
|
549
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
550
|
+
*/
|
|
551
|
+
readonly code: string
|
|
552
|
+
|
|
553
|
+
/**
|
|
554
|
+
* Bearer Token
|
|
555
|
+
* @type {string}
|
|
556
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
557
|
+
*/
|
|
558
|
+
readonly authorization?: string
|
|
559
|
+
}
|
|
560
|
+
|
|
470
561
|
/**
|
|
471
562
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
472
563
|
* @export
|
|
@@ -488,7 +579,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
488
579
|
readonly authorization?: string
|
|
489
580
|
|
|
490
581
|
/**
|
|
491
|
-
* 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>
|
|
582
|
+
* 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>
|
|
492
583
|
* @type {string}
|
|
493
584
|
* @memberof BankTransactionApiGetBankTransaction
|
|
494
585
|
*/
|
|
@@ -502,7 +593,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
502
593
|
*/
|
|
503
594
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
504
595
|
/**
|
|
505
|
-
*
|
|
596
|
+
* 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
|
|
506
597
|
* @type {any}
|
|
507
598
|
* @memberof BankTransactionApiImportBankTransactions
|
|
508
599
|
*/
|
|
@@ -558,14 +649,14 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
558
649
|
readonly authorization?: string
|
|
559
650
|
|
|
560
651
|
/**
|
|
561
|
-
* 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,
|
|
652
|
+
* 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>
|
|
562
653
|
* @type {string}
|
|
563
654
|
* @memberof BankTransactionApiListBankTransactions
|
|
564
655
|
*/
|
|
565
656
|
readonly filter?: string
|
|
566
657
|
|
|
567
658
|
/**
|
|
568
|
-
* 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,
|
|
659
|
+
* 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>
|
|
569
660
|
* @type {string}
|
|
570
661
|
* @memberof BankTransactionApiListBankTransactions
|
|
571
662
|
*/
|
|
@@ -579,14 +670,14 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
579
670
|
readonly search?: string
|
|
580
671
|
|
|
581
672
|
/**
|
|
582
|
-
* 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,
|
|
673
|
+
* 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>
|
|
583
674
|
* @type {string}
|
|
584
675
|
* @memberof BankTransactionApiListBankTransactions
|
|
585
676
|
*/
|
|
586
677
|
readonly order?: string
|
|
587
678
|
|
|
588
679
|
/**
|
|
589
|
-
* 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>
|
|
680
|
+
* 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>
|
|
590
681
|
* @type {string}
|
|
591
682
|
* @memberof BankTransactionApiListBankTransactions
|
|
592
683
|
*/
|
|
@@ -628,6 +719,18 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
628
719
|
* @extends {BaseAPI}
|
|
629
720
|
*/
|
|
630
721
|
export class BankTransactionApi extends BaseAPI {
|
|
722
|
+
/**
|
|
723
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
724
|
+
* @summary Invoice Match Suggestion
|
|
725
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
726
|
+
* @param {*} [options] Override http request option.
|
|
727
|
+
* @throws {RequiredError}
|
|
728
|
+
* @memberof BankTransactionApi
|
|
729
|
+
*/
|
|
730
|
+
public generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig) {
|
|
731
|
+
return BankTransactionApiFp(this.configuration).generateInvoiceMatchSuggestion(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
732
|
+
}
|
|
733
|
+
|
|
631
734
|
/**
|
|
632
735
|
* 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\"
|
|
633
736
|
* @summary Retrieve the bank transaction
|
|
@@ -641,7 +744,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
641
744
|
}
|
|
642
745
|
|
|
643
746
|
/**
|
|
644
|
-
* This will import bank transactions from a
|
|
747
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
645
748
|
* @summary Create the bank transactions
|
|
646
749
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
647
750
|
* @param {*} [options] Override http request option.
|