@emilgroup/payment-sdk 1.13.1-beta.4 → 1.13.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@1.13.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk@1.13.1-beta.6 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk@1.13.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk@1.13.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';
|
|
@@ -40,12 +42,57 @@ import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
|
40
42
|
*/
|
|
41
43
|
export const BankTransactionApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
42
44
|
return {
|
|
45
|
+
/**
|
|
46
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
47
|
+
* @summary Invoice Match Suggestion
|
|
48
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
49
|
+
* @param {string} [authorization] Bearer Token
|
|
50
|
+
* @param {*} [options] Override http request option.
|
|
51
|
+
* @throws {RequiredError}
|
|
52
|
+
*/
|
|
53
|
+
generateInvoiceMatchSuggestion: async (code: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54
|
+
// verify required parameter 'code' is not null or undefined
|
|
55
|
+
assertParamExists('generateInvoiceMatchSuggestion', 'code', code)
|
|
56
|
+
const localVarPath = `/paymentservice/v1/tenant/bank-transactions/{code}/generate-invoice-match-suggestion`
|
|
57
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
58
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
59
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
60
|
+
let baseOptions;
|
|
61
|
+
let baseAccessToken;
|
|
62
|
+
if (configuration) {
|
|
63
|
+
baseOptions = configuration.baseOptions;
|
|
64
|
+
baseAccessToken = configuration.accessToken;
|
|
65
|
+
}
|
|
66
|
+
|
|
67
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
68
|
+
const localVarHeaderParameter = {} as any;
|
|
69
|
+
const localVarQueryParameter = {} as any;
|
|
70
|
+
|
|
71
|
+
// authentication bearer required
|
|
72
|
+
// http bearer authentication required
|
|
73
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
74
|
+
|
|
75
|
+
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
76
|
+
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
|
|
81
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
82
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
83
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
84
|
+
|
|
85
|
+
return {
|
|
86
|
+
url: toPathString(localVarUrlObj),
|
|
87
|
+
options: localVarRequestOptions,
|
|
88
|
+
};
|
|
89
|
+
},
|
|
43
90
|
/**
|
|
44
91
|
* 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\"
|
|
45
92
|
* @summary Retrieve the bank transaction
|
|
46
93
|
* @param {string} code
|
|
47
94
|
* @param {string} [authorization] Bearer Token
|
|
48
|
-
* @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>
|
|
95
|
+
* @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>
|
|
49
96
|
* @param {*} [options] Override http request option.
|
|
50
97
|
* @throws {RequiredError}
|
|
51
98
|
*/
|
|
@@ -91,9 +138,9 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
91
138
|
};
|
|
92
139
|
},
|
|
93
140
|
/**
|
|
94
|
-
* This will import bank transactions from a
|
|
141
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
95
142
|
* @summary Create the bank transactions
|
|
96
|
-
* @param {any} file
|
|
143
|
+
* @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
|
|
97
144
|
* @param {string} [authorization] Bearer Token
|
|
98
145
|
* @param {*} [options] Override http request option.
|
|
99
146
|
* @throws {RequiredError}
|
|
@@ -197,11 +244,11 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
197
244
|
* 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\"
|
|
198
245
|
* @summary List bank transactions
|
|
199
246
|
* @param {string} [authorization] Bearer Token
|
|
200
|
-
* @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,
|
|
201
|
-
* @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,
|
|
247
|
+
* @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>
|
|
248
|
+
* @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>
|
|
202
249
|
* @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>
|
|
203
|
-
* @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,
|
|
204
|
-
* @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>
|
|
250
|
+
* @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>
|
|
251
|
+
* @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>
|
|
205
252
|
* @param {*} [options] Override http request option.
|
|
206
253
|
* @throws {RequiredError}
|
|
207
254
|
*/
|
|
@@ -320,12 +367,24 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
320
367
|
export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
321
368
|
const localVarAxiosParamCreator = BankTransactionApiAxiosParamCreator(configuration)
|
|
322
369
|
return {
|
|
370
|
+
/**
|
|
371
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
372
|
+
* @summary Invoice Match Suggestion
|
|
373
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
374
|
+
* @param {string} [authorization] Bearer Token
|
|
375
|
+
* @param {*} [options] Override http request option.
|
|
376
|
+
* @throws {RequiredError}
|
|
377
|
+
*/
|
|
378
|
+
async generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>> {
|
|
379
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.generateInvoiceMatchSuggestion(code, authorization, options);
|
|
380
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
381
|
+
},
|
|
323
382
|
/**
|
|
324
383
|
* 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\"
|
|
325
384
|
* @summary Retrieve the bank transaction
|
|
326
385
|
* @param {string} code
|
|
327
386
|
* @param {string} [authorization] Bearer Token
|
|
328
|
-
* @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>
|
|
387
|
+
* @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>
|
|
329
388
|
* @param {*} [options] Override http request option.
|
|
330
389
|
* @throws {RequiredError}
|
|
331
390
|
*/
|
|
@@ -334,9 +393,9 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
334
393
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
335
394
|
},
|
|
336
395
|
/**
|
|
337
|
-
* This will import bank transactions from a
|
|
396
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
338
397
|
* @summary Create the bank transactions
|
|
339
|
-
* @param {any} file
|
|
398
|
+
* @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
|
|
340
399
|
* @param {string} [authorization] Bearer Token
|
|
341
400
|
* @param {*} [options] Override http request option.
|
|
342
401
|
* @throws {RequiredError}
|
|
@@ -362,11 +421,11 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
362
421
|
* 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\"
|
|
363
422
|
* @summary List bank transactions
|
|
364
423
|
* @param {string} [authorization] Bearer Token
|
|
365
|
-
* @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,
|
|
366
|
-
* @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,
|
|
424
|
+
* @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>
|
|
425
|
+
* @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>
|
|
367
426
|
* @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>
|
|
368
|
-
* @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,
|
|
369
|
-
* @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>
|
|
427
|
+
* @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>
|
|
428
|
+
* @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>
|
|
370
429
|
* @param {*} [options] Override http request option.
|
|
371
430
|
* @throws {RequiredError}
|
|
372
431
|
*/
|
|
@@ -397,12 +456,23 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
397
456
|
export const BankTransactionApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
398
457
|
const localVarFp = BankTransactionApiFp(configuration)
|
|
399
458
|
return {
|
|
459
|
+
/**
|
|
460
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
461
|
+
* @summary Invoice Match Suggestion
|
|
462
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
463
|
+
* @param {string} [authorization] Bearer Token
|
|
464
|
+
* @param {*} [options] Override http request option.
|
|
465
|
+
* @throws {RequiredError}
|
|
466
|
+
*/
|
|
467
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass> {
|
|
468
|
+
return localVarFp.generateInvoiceMatchSuggestion(code, authorization, options).then((request) => request(axios, basePath));
|
|
469
|
+
},
|
|
400
470
|
/**
|
|
401
471
|
* 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\"
|
|
402
472
|
* @summary Retrieve the bank transaction
|
|
403
473
|
* @param {string} code
|
|
404
474
|
* @param {string} [authorization] Bearer Token
|
|
405
|
-
* @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>
|
|
475
|
+
* @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>
|
|
406
476
|
* @param {*} [options] Override http request option.
|
|
407
477
|
* @throws {RequiredError}
|
|
408
478
|
*/
|
|
@@ -410,9 +480,9 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
410
480
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then((request) => request(axios, basePath));
|
|
411
481
|
},
|
|
412
482
|
/**
|
|
413
|
-
* This will import bank transactions from a
|
|
483
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
414
484
|
* @summary Create the bank transactions
|
|
415
|
-
* @param {any} file
|
|
485
|
+
* @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
|
|
416
486
|
* @param {string} [authorization] Bearer Token
|
|
417
487
|
* @param {*} [options] Override http request option.
|
|
418
488
|
* @throws {RequiredError}
|
|
@@ -436,11 +506,11 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
436
506
|
* 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\"
|
|
437
507
|
* @summary List bank transactions
|
|
438
508
|
* @param {string} [authorization] Bearer Token
|
|
439
|
-
* @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,
|
|
440
|
-
* @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,
|
|
509
|
+
* @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>
|
|
510
|
+
* @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>
|
|
441
511
|
* @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>
|
|
442
|
-
* @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,
|
|
443
|
-
* @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>
|
|
512
|
+
* @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>
|
|
513
|
+
* @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>
|
|
444
514
|
* @param {*} [options] Override http request option.
|
|
445
515
|
* @throws {RequiredError}
|
|
446
516
|
*/
|
|
@@ -462,6 +532,27 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
462
532
|
};
|
|
463
533
|
};
|
|
464
534
|
|
|
535
|
+
/**
|
|
536
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
537
|
+
* @export
|
|
538
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
539
|
+
*/
|
|
540
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
541
|
+
/**
|
|
542
|
+
* Code of the bank transaction to generate match suggestions for
|
|
543
|
+
* @type {string}
|
|
544
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
545
|
+
*/
|
|
546
|
+
readonly code: string
|
|
547
|
+
|
|
548
|
+
/**
|
|
549
|
+
* Bearer Token
|
|
550
|
+
* @type {string}
|
|
551
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
552
|
+
*/
|
|
553
|
+
readonly authorization?: string
|
|
554
|
+
}
|
|
555
|
+
|
|
465
556
|
/**
|
|
466
557
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
467
558
|
* @export
|
|
@@ -483,7 +574,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
483
574
|
readonly authorization?: string
|
|
484
575
|
|
|
485
576
|
/**
|
|
486
|
-
* 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>
|
|
577
|
+
* 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>
|
|
487
578
|
* @type {string}
|
|
488
579
|
* @memberof BankTransactionApiGetBankTransaction
|
|
489
580
|
*/
|
|
@@ -497,7 +588,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
497
588
|
*/
|
|
498
589
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
499
590
|
/**
|
|
500
|
-
*
|
|
591
|
+
* 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
|
|
501
592
|
* @type {any}
|
|
502
593
|
* @memberof BankTransactionApiImportBankTransactions
|
|
503
594
|
*/
|
|
@@ -553,14 +644,14 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
553
644
|
readonly authorization?: string
|
|
554
645
|
|
|
555
646
|
/**
|
|
556
|
-
* 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,
|
|
647
|
+
* 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>
|
|
557
648
|
* @type {string}
|
|
558
649
|
* @memberof BankTransactionApiListBankTransactions
|
|
559
650
|
*/
|
|
560
651
|
readonly filter?: string
|
|
561
652
|
|
|
562
653
|
/**
|
|
563
|
-
* 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,
|
|
654
|
+
* 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>
|
|
564
655
|
* @type {string}
|
|
565
656
|
* @memberof BankTransactionApiListBankTransactions
|
|
566
657
|
*/
|
|
@@ -574,14 +665,14 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
574
665
|
readonly search?: string
|
|
575
666
|
|
|
576
667
|
/**
|
|
577
|
-
* 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,
|
|
668
|
+
* 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>
|
|
578
669
|
* @type {string}
|
|
579
670
|
* @memberof BankTransactionApiListBankTransactions
|
|
580
671
|
*/
|
|
581
672
|
readonly order?: string
|
|
582
673
|
|
|
583
674
|
/**
|
|
584
|
-
* 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>
|
|
675
|
+
* 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>
|
|
585
676
|
* @type {string}
|
|
586
677
|
* @memberof BankTransactionApiListBankTransactions
|
|
587
678
|
*/
|
|
@@ -623,6 +714,18 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
623
714
|
* @extends {BaseAPI}
|
|
624
715
|
*/
|
|
625
716
|
export class BankTransactionApi extends BaseAPI {
|
|
717
|
+
/**
|
|
718
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
719
|
+
* @summary Invoice Match Suggestion
|
|
720
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
721
|
+
* @param {*} [options] Override http request option.
|
|
722
|
+
* @throws {RequiredError}
|
|
723
|
+
* @memberof BankTransactionApi
|
|
724
|
+
*/
|
|
725
|
+
public generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig) {
|
|
726
|
+
return BankTransactionApiFp(this.configuration).generateInvoiceMatchSuggestion(requestParameters.code, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
727
|
+
}
|
|
728
|
+
|
|
626
729
|
/**
|
|
627
730
|
* 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\"
|
|
628
731
|
* @summary Retrieve the bank transaction
|
|
@@ -636,7 +739,7 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
636
739
|
}
|
|
637
740
|
|
|
638
741
|
/**
|
|
639
|
-
* This will import bank transactions from a
|
|
742
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
640
743
|
* @summary Create the bank transactions
|
|
641
744
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
642
745
|
* @param {*} [options] Override http request option.
|