@emilgroup/payment-sdk 1.22.1-beta.72 → 1.22.1-beta.73
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 +4 -0
- package/README.md +2 -2
- package/api/bank-transaction-api.ts +130 -8
- package/dist/api/bank-transaction-api.d.ts +74 -8
- package/dist/api/bank-transaction-api.js +108 -6
- package/dist/models/bank-transaction-class.d.ts +7 -0
- package/dist/models/bank-transaction-entity.d.ts +7 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.d.ts +30 -0
- package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.js +15 -0
- package/dist/models/link-bank-transaction-payment-requests-response-class.d.ts +25 -0
- package/dist/models/link-bank-transaction-payment-requests-response-class.js +15 -0
- package/dist/models/payment-receipt-class.d.ts +12 -0
- package/dist/models/payment-receipt-entity.d.ts +139 -0
- package/dist/models/payment-receipt-entity.js +20 -0
- package/dist/models/payment-request-class.d.ts +1 -0
- package/dist/models/payment-request-class.js +1 -0
- package/dist/models/payment-request-entity.d.ts +223 -0
- package/dist/models/payment-request-entity.js +39 -0
- package/models/bank-transaction-class.ts +7 -0
- package/models/bank-transaction-entity.ts +7 -0
- package/models/index.ts +4 -0
- package/models/link-bank-transaction-payment-requests-request-dto-rest.ts +36 -0
- package/models/link-bank-transaction-payment-requests-response-class.ts +31 -0
- package/models/payment-receipt-class.ts +12 -0
- package/models/payment-receipt-entity.ts +148 -0
- package/models/payment-request-class.ts +1 -0
- package/models/payment-request-entity.ts +233 -0
- package/package.json +1 -1
package/.openapi-generator/FILES
CHANGED
|
@@ -122,6 +122,8 @@ models/inline-response503.ts
|
|
|
122
122
|
models/invoice-allocation-dto.ts
|
|
123
123
|
models/invoice-match-suggestion-class.ts
|
|
124
124
|
models/invoice-match-suggestion-entity.ts
|
|
125
|
+
models/link-bank-transaction-payment-requests-request-dto-rest.ts
|
|
126
|
+
models/link-bank-transaction-payment-requests-response-class.ts
|
|
125
127
|
models/link-bank-transaction-request-dto-rest.ts
|
|
126
128
|
models/link-bank-transactions-response-class.ts
|
|
127
129
|
models/list-bank-accounts-response-class.ts
|
|
@@ -147,8 +149,10 @@ models/payment-class.ts
|
|
|
147
149
|
models/payment-entity.ts
|
|
148
150
|
models/payment-method-class.ts
|
|
149
151
|
models/payment-receipt-class.ts
|
|
152
|
+
models/payment-receipt-entity.ts
|
|
150
153
|
models/payment-reminder-class.ts
|
|
151
154
|
models/payment-request-class.ts
|
|
155
|
+
models/payment-request-entity.ts
|
|
152
156
|
models/payout-method-class.ts
|
|
153
157
|
models/policy-payment-method-class.ts
|
|
154
158
|
models/primary-bank-account-response-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.22.1-beta.
|
|
20
|
+
npm install @emilgroup/payment-sdk@1.22.1-beta.73 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/payment-sdk@1.22.1-beta.
|
|
24
|
+
yarn add @emilgroup/payment-sdk@1.22.1-beta.73
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `PaymentsApi`.
|
|
@@ -27,6 +27,10 @@ import { GetBankTransactionsResponseClass } from '../models';
|
|
|
27
27
|
// @ts-ignore
|
|
28
28
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
29
29
|
// @ts-ignore
|
|
30
|
+
import { LinkBankTransactionPaymentRequestsRequestDtoRest } from '../models';
|
|
31
|
+
// @ts-ignore
|
|
32
|
+
import { LinkBankTransactionPaymentRequestsResponseClass } from '../models';
|
|
33
|
+
// @ts-ignore
|
|
30
34
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
31
35
|
// @ts-ignore
|
|
32
36
|
import { LinkBankTransactionsResponseClass } from '../models';
|
|
@@ -92,7 +96,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
92
96
|
* @summary Retrieve the bank transaction
|
|
93
97
|
* @param {string} code
|
|
94
98
|
* @param {string} [authorization] Bearer Token
|
|
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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
96
100
|
* @param {*} [options] Override http request option.
|
|
97
101
|
* @throws {RequiredError}
|
|
98
102
|
*/
|
|
@@ -246,6 +250,59 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
246
250
|
options: localVarRequestOptions,
|
|
247
251
|
};
|
|
248
252
|
},
|
|
253
|
+
/**
|
|
254
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
255
|
+
* @summary Link bank transaction to payment requests
|
|
256
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
257
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
258
|
+
* @param {string} [authorization] Bearer Token
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
linkBankTransactionPaymentRequests: async (code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
263
|
+
// verify required parameter 'code' is not null or undefined
|
|
264
|
+
assertParamExists('linkBankTransactionPaymentRequests', 'code', code)
|
|
265
|
+
// verify required parameter 'linkBankTransactionPaymentRequestsRequestDtoRest' is not null or undefined
|
|
266
|
+
assertParamExists('linkBankTransactionPaymentRequests', 'linkBankTransactionPaymentRequestsRequestDtoRest', linkBankTransactionPaymentRequestsRequestDtoRest)
|
|
267
|
+
const localVarPath = `/paymentservice/v1/tenant/bank-transactions/{code}/link-payment-requests`
|
|
268
|
+
.replace(`{${"code"}}`, encodeURIComponent(String(code)));
|
|
269
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
270
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
271
|
+
let baseOptions;
|
|
272
|
+
let baseAccessToken;
|
|
273
|
+
if (configuration) {
|
|
274
|
+
baseOptions = configuration.baseOptions;
|
|
275
|
+
baseAccessToken = configuration.accessToken;
|
|
276
|
+
}
|
|
277
|
+
|
|
278
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
279
|
+
const localVarHeaderParameter = {} as any;
|
|
280
|
+
const localVarQueryParameter = {} as any;
|
|
281
|
+
|
|
282
|
+
// authentication bearer required
|
|
283
|
+
// http bearer authentication required
|
|
284
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
285
|
+
|
|
286
|
+
// Only Authorization falls back to the configured token; an empty value is never sent.
|
|
287
|
+
const authorizationValue = 'Authorization'.toLowerCase() === 'authorization' ? (authorization || baseAccessToken) : authorization;
|
|
288
|
+
if (authorizationValue) {
|
|
289
|
+
localVarHeaderParameter['Authorization'] = String(authorizationValue);
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
295
|
+
|
|
296
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
297
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
298
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
299
|
+
localVarRequestOptions.data = serializeDataIfNeeded(linkBankTransactionPaymentRequestsRequestDtoRest, localVarRequestOptions, configuration)
|
|
300
|
+
|
|
301
|
+
return {
|
|
302
|
+
url: toPathString(localVarUrlObj),
|
|
303
|
+
options: localVarRequestOptions,
|
|
304
|
+
};
|
|
305
|
+
},
|
|
249
306
|
/**
|
|
250
307
|
* 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\"
|
|
251
308
|
* @summary List bank transactions
|
|
@@ -255,7 +312,7 @@ export const BankTransactionApiAxiosParamCreator = function (configuration?: Con
|
|
|
255
312
|
* @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>
|
|
256
313
|
* @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>
|
|
257
314
|
* @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>
|
|
258
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
315
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
259
316
|
* @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>
|
|
260
317
|
* @param {*} [options] Override http request option.
|
|
261
318
|
* @throws {RequiredError}
|
|
@@ -398,7 +455,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
398
455
|
* @summary Retrieve the bank transaction
|
|
399
456
|
* @param {string} code
|
|
400
457
|
* @param {string} [authorization] Bearer Token
|
|
401
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
458
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
402
459
|
* @param {*} [options] Override http request option.
|
|
403
460
|
* @throws {RequiredError}
|
|
404
461
|
*/
|
|
@@ -431,6 +488,19 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
431
488
|
const localVarAxiosArgs = await localVarAxiosParamCreator.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options);
|
|
432
489
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
433
490
|
},
|
|
491
|
+
/**
|
|
492
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
493
|
+
* @summary Link bank transaction to payment requests
|
|
494
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
495
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
496
|
+
* @param {string} [authorization] Bearer Token
|
|
497
|
+
* @param {*} [options] Override http request option.
|
|
498
|
+
* @throws {RequiredError}
|
|
499
|
+
*/
|
|
500
|
+
async linkBankTransactionPaymentRequests(code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkBankTransactionPaymentRequestsResponseClass>> {
|
|
501
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.linkBankTransactionPaymentRequests(code, linkBankTransactionPaymentRequestsRequestDtoRest, authorization, options);
|
|
502
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
503
|
+
},
|
|
434
504
|
/**
|
|
435
505
|
* 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\"
|
|
436
506
|
* @summary List bank transactions
|
|
@@ -440,7 +510,7 @@ export const BankTransactionApiFp = function(configuration?: Configuration) {
|
|
|
440
510
|
* @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>
|
|
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
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>
|
|
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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
444
514
|
* @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>
|
|
445
515
|
* @param {*} [options] Override http request option.
|
|
446
516
|
* @throws {RequiredError}
|
|
@@ -487,7 +557,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
487
557
|
* @summary Retrieve the bank transaction
|
|
488
558
|
* @param {string} code
|
|
489
559
|
* @param {string} [authorization] Bearer Token
|
|
490
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
560
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
491
561
|
* @param {*} [options] Override http request option.
|
|
492
562
|
* @throws {RequiredError}
|
|
493
563
|
*/
|
|
@@ -517,6 +587,18 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
517
587
|
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionsResponseClass> {
|
|
518
588
|
return localVarFp.linkBankTransaction(code, linkBankTransactionRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
519
589
|
},
|
|
590
|
+
/**
|
|
591
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
592
|
+
* @summary Link bank transaction to payment requests
|
|
593
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
594
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
595
|
+
* @param {string} [authorization] Bearer Token
|
|
596
|
+
* @param {*} [options] Override http request option.
|
|
597
|
+
* @throws {RequiredError}
|
|
598
|
+
*/
|
|
599
|
+
linkBankTransactionPaymentRequests(code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionPaymentRequestsResponseClass> {
|
|
600
|
+
return localVarFp.linkBankTransactionPaymentRequests(code, linkBankTransactionPaymentRequestsRequestDtoRest, authorization, options).then((request) => request(axios, basePath));
|
|
601
|
+
},
|
|
520
602
|
/**
|
|
521
603
|
* 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\"
|
|
522
604
|
* @summary List bank transactions
|
|
@@ -526,7 +608,7 @@ export const BankTransactionApiFactory = function (configuration?: Configuration
|
|
|
526
608
|
* @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>
|
|
527
609
|
* @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>
|
|
528
610
|
* @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>
|
|
529
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
611
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
530
612
|
* @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>
|
|
531
613
|
* @param {*} [options] Override http request option.
|
|
532
614
|
* @throws {RequiredError}
|
|
@@ -590,7 +672,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
590
672
|
readonly authorization?: string
|
|
591
673
|
|
|
592
674
|
/**
|
|
593
|
-
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
594
676
|
* @type {string}
|
|
595
677
|
* @memberof BankTransactionApiGetBankTransaction
|
|
596
678
|
*/
|
|
@@ -646,6 +728,34 @@ export interface BankTransactionApiLinkBankTransactionRequest {
|
|
|
646
728
|
readonly authorization?: string
|
|
647
729
|
}
|
|
648
730
|
|
|
731
|
+
/**
|
|
732
|
+
* Request parameters for linkBankTransactionPaymentRequests operation in BankTransactionApi.
|
|
733
|
+
* @export
|
|
734
|
+
* @interface BankTransactionApiLinkBankTransactionPaymentRequestsRequest
|
|
735
|
+
*/
|
|
736
|
+
export interface BankTransactionApiLinkBankTransactionPaymentRequestsRequest {
|
|
737
|
+
/**
|
|
738
|
+
* Code of the outgoing bank transaction to link
|
|
739
|
+
* @type {string}
|
|
740
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
741
|
+
*/
|
|
742
|
+
readonly code: string
|
|
743
|
+
|
|
744
|
+
/**
|
|
745
|
+
*
|
|
746
|
+
* @type {LinkBankTransactionPaymentRequestsRequestDtoRest}
|
|
747
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
748
|
+
*/
|
|
749
|
+
readonly linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest
|
|
750
|
+
|
|
751
|
+
/**
|
|
752
|
+
* Bearer Token
|
|
753
|
+
* @type {string}
|
|
754
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
755
|
+
*/
|
|
756
|
+
readonly authorization?: string
|
|
757
|
+
}
|
|
758
|
+
|
|
649
759
|
/**
|
|
650
760
|
* Request parameters for listBankTransactions operation in BankTransactionApi.
|
|
651
761
|
* @export
|
|
@@ -695,7 +805,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
695
805
|
readonly order?: string
|
|
696
806
|
|
|
697
807
|
/**
|
|
698
|
-
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
808
|
+
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
699
809
|
* @type {string}
|
|
700
810
|
* @memberof BankTransactionApiListBankTransactions
|
|
701
811
|
*/
|
|
@@ -785,6 +895,18 @@ export class BankTransactionApi extends BaseAPI {
|
|
|
785
895
|
return BankTransactionApiFp(this.configuration).linkBankTransaction(requestParameters.code, requestParameters.linkBankTransactionRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
786
896
|
}
|
|
787
897
|
|
|
898
|
+
/**
|
|
899
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
900
|
+
* @summary Link bank transaction to payment requests
|
|
901
|
+
* @param {BankTransactionApiLinkBankTransactionPaymentRequestsRequest} requestParameters Request parameters.
|
|
902
|
+
* @param {*} [options] Override http request option.
|
|
903
|
+
* @throws {RequiredError}
|
|
904
|
+
* @memberof BankTransactionApi
|
|
905
|
+
*/
|
|
906
|
+
public linkBankTransactionPaymentRequests(requestParameters: BankTransactionApiLinkBankTransactionPaymentRequestsRequest, options?: AxiosRequestConfig) {
|
|
907
|
+
return BankTransactionApiFp(this.configuration).linkBankTransactionPaymentRequests(requestParameters.code, requestParameters.linkBankTransactionPaymentRequestsRequestDtoRest, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
|
|
908
|
+
}
|
|
909
|
+
|
|
788
910
|
/**
|
|
789
911
|
* 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\"
|
|
790
912
|
* @summary List bank transactions
|
|
@@ -15,6 +15,8 @@ import { RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
16
16
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
17
17
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
18
|
+
import { LinkBankTransactionPaymentRequestsRequestDtoRest } from '../models';
|
|
19
|
+
import { LinkBankTransactionPaymentRequestsResponseClass } from '../models';
|
|
18
20
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
19
21
|
import { LinkBankTransactionsResponseClass } from '../models';
|
|
20
22
|
import { ListBankTransactionsResponseClass } from '../models';
|
|
@@ -38,7 +40,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
38
40
|
* @summary Retrieve the bank transaction
|
|
39
41
|
* @param {string} code
|
|
40
42
|
* @param {string} [authorization] Bearer Token
|
|
41
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
43
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
42
44
|
* @param {*} [options] Override http request option.
|
|
43
45
|
* @throws {RequiredError}
|
|
44
46
|
*/
|
|
@@ -62,6 +64,16 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
62
64
|
* @throws {RequiredError}
|
|
63
65
|
*/
|
|
64
66
|
linkBankTransaction: (code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
67
|
+
/**
|
|
68
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
69
|
+
* @summary Link bank transaction to payment requests
|
|
70
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
71
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
72
|
+
* @param {string} [authorization] Bearer Token
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
linkBankTransactionPaymentRequests: (code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
77
|
/**
|
|
66
78
|
* 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\"
|
|
67
79
|
* @summary List bank transactions
|
|
@@ -71,7 +83,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
71
83
|
* @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>
|
|
72
84
|
* @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>
|
|
73
85
|
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
86
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
75
87
|
* @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>
|
|
76
88
|
* @param {*} [options] Override http request option.
|
|
77
89
|
* @throws {RequiredError}
|
|
@@ -106,7 +118,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
106
118
|
* @summary Retrieve the bank transaction
|
|
107
119
|
* @param {string} code
|
|
108
120
|
* @param {string} [authorization] Bearer Token
|
|
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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
121
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
110
122
|
* @param {*} [options] Override http request option.
|
|
111
123
|
* @throws {RequiredError}
|
|
112
124
|
*/
|
|
@@ -130,6 +142,16 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
130
142
|
* @throws {RequiredError}
|
|
131
143
|
*/
|
|
132
144
|
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkBankTransactionsResponseClass>>;
|
|
145
|
+
/**
|
|
146
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
147
|
+
* @summary Link bank transaction to payment requests
|
|
148
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
149
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
150
|
+
* @param {string} [authorization] Bearer Token
|
|
151
|
+
* @param {*} [options] Override http request option.
|
|
152
|
+
* @throws {RequiredError}
|
|
153
|
+
*/
|
|
154
|
+
linkBankTransactionPaymentRequests(code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LinkBankTransactionPaymentRequestsResponseClass>>;
|
|
133
155
|
/**
|
|
134
156
|
* 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\"
|
|
135
157
|
* @summary List bank transactions
|
|
@@ -139,7 +161,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
139
161
|
* @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>
|
|
140
162
|
* @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>
|
|
141
163
|
* @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>
|
|
142
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
164
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
143
165
|
* @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>
|
|
144
166
|
* @param {*} [options] Override http request option.
|
|
145
167
|
* @throws {RequiredError}
|
|
@@ -174,7 +196,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
174
196
|
* @summary Retrieve the bank transaction
|
|
175
197
|
* @param {string} code
|
|
176
198
|
* @param {string} [authorization] Bearer Token
|
|
177
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
199
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
178
200
|
* @param {*} [options] Override http request option.
|
|
179
201
|
* @throws {RequiredError}
|
|
180
202
|
*/
|
|
@@ -198,6 +220,16 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
198
220
|
* @throws {RequiredError}
|
|
199
221
|
*/
|
|
200
222
|
linkBankTransaction(code: string, linkBankTransactionRequestDtoRest: LinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionsResponseClass>;
|
|
223
|
+
/**
|
|
224
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
225
|
+
* @summary Link bank transaction to payment requests
|
|
226
|
+
* @param {string} code Code of the outgoing bank transaction to link
|
|
227
|
+
* @param {LinkBankTransactionPaymentRequestsRequestDtoRest} linkBankTransactionPaymentRequestsRequestDtoRest
|
|
228
|
+
* @param {string} [authorization] Bearer Token
|
|
229
|
+
* @param {*} [options] Override http request option.
|
|
230
|
+
* @throws {RequiredError}
|
|
231
|
+
*/
|
|
232
|
+
linkBankTransactionPaymentRequests(code: string, linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest, authorization?: string, options?: any): AxiosPromise<LinkBankTransactionPaymentRequestsResponseClass>;
|
|
201
233
|
/**
|
|
202
234
|
* 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
235
|
* @summary List bank transactions
|
|
@@ -207,7 +239,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
207
239
|
* @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>
|
|
208
240
|
* @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>
|
|
209
241
|
* @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>
|
|
210
|
-
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
242
|
+
* @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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
211
243
|
* @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>
|
|
212
244
|
* @param {*} [options] Override http request option.
|
|
213
245
|
* @throws {RequiredError}
|
|
@@ -261,7 +293,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
261
293
|
*/
|
|
262
294
|
readonly authorization?: string;
|
|
263
295
|
/**
|
|
264
|
-
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
296
|
+
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
265
297
|
* @type {string}
|
|
266
298
|
* @memberof BankTransactionApiGetBankTransaction
|
|
267
299
|
*/
|
|
@@ -311,6 +343,31 @@ export interface BankTransactionApiLinkBankTransactionRequest {
|
|
|
311
343
|
*/
|
|
312
344
|
readonly authorization?: string;
|
|
313
345
|
}
|
|
346
|
+
/**
|
|
347
|
+
* Request parameters for linkBankTransactionPaymentRequests operation in BankTransactionApi.
|
|
348
|
+
* @export
|
|
349
|
+
* @interface BankTransactionApiLinkBankTransactionPaymentRequestsRequest
|
|
350
|
+
*/
|
|
351
|
+
export interface BankTransactionApiLinkBankTransactionPaymentRequestsRequest {
|
|
352
|
+
/**
|
|
353
|
+
* Code of the outgoing bank transaction to link
|
|
354
|
+
* @type {string}
|
|
355
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
356
|
+
*/
|
|
357
|
+
readonly code: string;
|
|
358
|
+
/**
|
|
359
|
+
*
|
|
360
|
+
* @type {LinkBankTransactionPaymentRequestsRequestDtoRest}
|
|
361
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
362
|
+
*/
|
|
363
|
+
readonly linkBankTransactionPaymentRequestsRequestDtoRest: LinkBankTransactionPaymentRequestsRequestDtoRest;
|
|
364
|
+
/**
|
|
365
|
+
* Bearer Token
|
|
366
|
+
* @type {string}
|
|
367
|
+
* @memberof BankTransactionApiLinkBankTransactionPaymentRequests
|
|
368
|
+
*/
|
|
369
|
+
readonly authorization?: string;
|
|
370
|
+
}
|
|
314
371
|
/**
|
|
315
372
|
* Request parameters for listBankTransactions operation in BankTransactionApi.
|
|
316
373
|
* @export
|
|
@@ -354,7 +411,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
354
411
|
*/
|
|
355
412
|
readonly order?: string;
|
|
356
413
|
/**
|
|
357
|
-
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices<i>
|
|
414
|
+
* 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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder, bankTransactionInvoices, paymentReceipts<i>
|
|
358
415
|
* @type {string}
|
|
359
416
|
* @memberof BankTransactionApiListBankTransactions
|
|
360
417
|
*/
|
|
@@ -428,6 +485,15 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
428
485
|
* @memberof BankTransactionApi
|
|
429
486
|
*/
|
|
430
487
|
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionsResponseClass, any, {}, any>>;
|
|
488
|
+
/**
|
|
489
|
+
* Links an outgoing bank transaction to the payout payment requests it paid. In one database transaction it creates one payment receipt per request for the full request amount, which marks each request paid, closes every bank order of the requests that has no open request left, and marks the transaction linked. The requests must be open payouts (claim regulations, refund allocations or commission settlements) in the transaction currency without receipts, and their amounts must add up to the transaction amount. A request in a bank order must be in a payout order past draft that pays from the tenant bank account of the transaction. A bank order given by its code is linked with every open payment request it holds in the transaction currency at the time of the link; it must be such an order, not closed, with at least one. **Required Permissions** \"payment-management.bank-accounts.create\", \"payment-management.payments.create\", \"payment-management.bank-orders.update\"
|
|
490
|
+
* @summary Link bank transaction to payment requests
|
|
491
|
+
* @param {BankTransactionApiLinkBankTransactionPaymentRequestsRequest} requestParameters Request parameters.
|
|
492
|
+
* @param {*} [options] Override http request option.
|
|
493
|
+
* @throws {RequiredError}
|
|
494
|
+
* @memberof BankTransactionApi
|
|
495
|
+
*/
|
|
496
|
+
linkBankTransactionPaymentRequests(requestParameters: BankTransactionApiLinkBankTransactionPaymentRequestsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionPaymentRequestsResponseClass, any, {}, any>>;
|
|
431
497
|
/**
|
|
432
498
|
* 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\"
|
|
433
499
|
* @summary List bank transactions
|