@emilgroup/payment-sdk 1.22.1-beta.82 → 1.22.1-beta.83
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 +0 -8
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +18 -48
- package/api/bank-orders-api.ts +15 -40
- package/api/bank-transaction-api.ts +26 -181
- package/api/billing-addresses-api.ts +15 -40
- package/api/credit-allocation-api.ts +9 -24
- package/api/exceeding-credits-api.ts +6 -240
- package/api/health-check-api.ts +1 -1
- package/api/ibanvalidator-api.ts +3 -8
- package/api/payment-methods-api.ts +9 -24
- package/api/payment-receipts-api.ts +15 -40
- package/api/payment-reminders-api.ts +12 -32
- package/api/payment-requests-api.ts +27 -52
- package/api/payment-setup-api.ts +6 -16
- package/api/payments-api.ts +16 -46
- package/api/payout-methods-api.ts +18 -48
- package/api/policy-payment-methods-api.ts +9 -24
- package/api/refunds-api.ts +9 -24
- package/api/tenant-bank-account-api.ts +15 -40
- package/api/webhooks-api.ts +2 -2
- package/base.ts +43 -239
- package/common.ts +2 -3
- package/configuration.ts +0 -20
- package/dist/api/bank-accounts-api.d.ts +6 -6
- package/dist/api/bank-accounts-api.js +46 -82
- package/dist/api/bank-orders-api.d.ts +5 -5
- package/dist/api/bank-orders-api.js +38 -67
- package/dist/api/bank-transaction-api.d.ts +14 -80
- package/dist/api/bank-transaction-api.js +52 -194
- package/dist/api/billing-addresses-api.d.ts +5 -5
- package/dist/api/billing-addresses-api.js +39 -71
- package/dist/api/credit-allocation-api.d.ts +3 -3
- package/dist/api/credit-allocation-api.js +23 -41
- package/dist/api/exceeding-credits-api.d.ts +2 -116
- package/dist/api/exceeding-credits-api.js +15 -226
- package/dist/api/health-check-api.d.ts +1 -1
- package/dist/api/health-check-api.js +1 -1
- package/dist/api/ibanvalidator-api.d.ts +1 -1
- package/dist/api/ibanvalidator-api.js +8 -15
- package/dist/api/payment-methods-api.d.ts +3 -3
- package/dist/api/payment-methods-api.js +23 -41
- package/dist/api/payment-receipts-api.d.ts +5 -5
- package/dist/api/payment-receipts-api.js +38 -67
- package/dist/api/payment-reminders-api.d.ts +4 -4
- package/dist/api/payment-reminders-api.js +31 -56
- package/dist/api/payment-requests-api.d.ts +17 -17
- package/dist/api/payment-requests-api.js +47 -76
- package/dist/api/payment-setup-api.d.ts +2 -2
- package/dist/api/payment-setup-api.js +16 -30
- package/dist/api/payments-api.d.ts +4 -4
- package/dist/api/payments-api.js +34 -62
- package/dist/api/payout-methods-api.d.ts +6 -6
- package/dist/api/payout-methods-api.js +46 -82
- package/dist/api/policy-payment-methods-api.d.ts +3 -3
- package/dist/api/policy-payment-methods-api.js +23 -41
- package/dist/api/refunds-api.d.ts +3 -3
- package/dist/api/refunds-api.js +22 -37
- package/dist/api/tenant-bank-account-api.d.ts +5 -5
- package/dist/api/tenant-bank-account-api.js +38 -67
- package/dist/api/webhooks-api.d.ts +2 -2
- package/dist/api/webhooks-api.js +2 -2
- package/dist/base.d.ts +0 -26
- package/dist/base.js +60 -243
- package/dist/common.d.ts +1 -1
- package/dist/common.js +0 -1
- package/dist/configuration.d.ts +0 -17
- package/dist/configuration.js +0 -2
- package/dist/models/bank-transaction-class.d.ts +0 -7
- package/dist/models/bank-transaction-entity.d.ts +0 -7
- package/dist/models/bank-transaction-invoice-entity.d.ts +0 -24
- package/dist/models/create-payment-order-dto.d.ts +1 -1
- package/dist/models/create-payment-receipt-request-dto.d.ts +3 -3
- package/dist/models/create-payment-request-dto.d.ts +1 -1
- package/dist/models/create-payment-request-request-dto.d.ts +0 -6
- package/dist/models/credit-allocation-class.d.ts +0 -6
- package/dist/models/credit-allocation-entity.d.ts +0 -6
- package/dist/models/exceeding-credit-class.d.ts +2 -25
- package/dist/models/exceeding-credit-class.js +1 -5
- package/dist/models/exceeding-credit-entity.d.ts +2 -31
- package/dist/models/exceeding-credit-entity.js +1 -5
- package/dist/models/index.d.ts +0 -8
- package/dist/models/index.js +0 -8
- package/dist/models/list-billing-addresses-response-class.d.ts +9 -9
- package/dist/models/list-exceeding-credits-response-class.d.ts +18 -6
- package/dist/models/list-payment-receipts-response-class.d.ts +9 -9
- package/dist/models/list-payment-requests-response-class.d.ts +18 -6
- package/dist/models/list-payout-methods-response-class.d.ts +9 -9
- package/dist/models/list-refunds-response-class.d.ts +18 -6
- package/dist/models/payment-class-without-expand-properties.d.ts +2 -2
- package/dist/models/payment-class.d.ts +2 -2
- package/dist/models/payment-entity.d.ts +1 -1
- package/dist/models/payment-receipt-class.d.ts +1 -13
- package/dist/models/payment-request-class.d.ts +6 -13
- package/dist/models/payment-request-class.js +0 -1
- package/dist/models/shared-transaction-class.d.ts +0 -6
- package/dist/models/transaction-entity.d.ts +0 -6
- package/models/bank-transaction-class.ts +0 -7
- package/models/bank-transaction-entity.ts +0 -7
- package/models/bank-transaction-invoice-entity.ts +0 -24
- package/models/create-payment-order-dto.ts +1 -1
- package/models/create-payment-receipt-request-dto.ts +3 -3
- package/models/create-payment-request-dto.ts +1 -1
- package/models/create-payment-request-request-dto.ts +0 -6
- package/models/credit-allocation-class.ts +0 -6
- package/models/credit-allocation-entity.ts +0 -6
- package/models/exceeding-credit-class.ts +2 -26
- package/models/exceeding-credit-entity.ts +2 -32
- package/models/index.ts +0 -8
- package/models/list-billing-addresses-response-class.ts +9 -9
- package/models/list-exceeding-credits-response-class.ts +18 -6
- package/models/list-payment-receipts-response-class.ts +9 -9
- package/models/list-payment-requests-response-class.ts +18 -6
- package/models/list-payout-methods-response-class.ts +9 -9
- package/models/list-refunds-response-class.ts +18 -6
- package/models/payment-class-without-expand-properties.ts +2 -2
- package/models/payment-class.ts +2 -2
- package/models/payment-entity.ts +1 -1
- package/models/payment-receipt-class.ts +1 -13
- package/models/payment-request-class.ts +6 -13
- package/models/shared-transaction-class.ts +0 -6
- package/models/transaction-entity.ts +0 -6
- package/package.json +2 -2
- package/dist/models/create-exceeding-credit-request-dto.d.ts +0 -48
- package/dist/models/create-exceeding-credit-request-dto.js +0 -15
- package/dist/models/create-exceeding-credit-response-class.d.ts +0 -25
- package/dist/models/create-exceeding-credit-response-class.js +0 -15
- package/dist/models/create-return-premium-credits-request-dto.d.ts +0 -24
- package/dist/models/create-return-premium-credits-request-dto.js +0 -15
- package/dist/models/create-return-premium-credits-response-class.d.ts +0 -25
- package/dist/models/create-return-premium-credits-response-class.js +0 -15
- package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.d.ts +0 -30
- package/dist/models/link-bank-transaction-payment-requests-request-dto-rest.js +0 -15
- package/dist/models/link-bank-transaction-payment-requests-response-class.d.ts +0 -25
- package/dist/models/link-bank-transaction-payment-requests-response-class.js +0 -15
- package/dist/models/payment-receipt-entity.d.ts +0 -139
- package/dist/models/payment-receipt-entity.js +0 -20
- package/dist/models/payment-request-entity.d.ts +0 -223
- package/dist/models/payment-request-entity.js +0 -39
- package/models/create-exceeding-credit-request-dto.ts +0 -54
- package/models/create-exceeding-credit-response-class.ts +0 -31
- package/models/create-return-premium-credits-request-dto.ts +0 -30
- package/models/create-return-premium-credits-response-class.ts +0 -31
- package/models/link-bank-transaction-payment-requests-request-dto-rest.ts +0 -36
- package/models/link-bank-transaction-payment-requests-response-class.ts +0 -31
- package/models/payment-receipt-entity.ts +0 -148
- package/models/payment-request-entity.ts +0 -233
|
@@ -15,8 +15,6 @@ 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';
|
|
20
18
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
21
19
|
import { LinkBankTransactionsResponseClass } from '../models';
|
|
22
20
|
import { ListBankTransactionsResponseClass } from '../models';
|
|
@@ -40,7 +38,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
40
38
|
* @summary Retrieve the bank transaction
|
|
41
39
|
* @param {string} code
|
|
42
40
|
* @param {string} [authorization] Bearer Token
|
|
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
|
|
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>
|
|
44
42
|
* @param {*} [options] Override http request option.
|
|
45
43
|
* @throws {RequiredError}
|
|
46
44
|
*/
|
|
@@ -64,16 +62,6 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
64
62
|
* @throws {RequiredError}
|
|
65
63
|
*/
|
|
66
64
|
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 that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), 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>;
|
|
77
65
|
/**
|
|
78
66
|
* 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\"
|
|
79
67
|
* @summary List bank transactions
|
|
@@ -83,7 +71,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
83
71
|
* @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>
|
|
84
72
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
85
73
|
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
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
|
|
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>
|
|
87
75
|
* @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>
|
|
88
76
|
* @param {*} [options] Override http request option.
|
|
89
77
|
* @throws {RequiredError}
|
|
@@ -118,7 +106,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
118
106
|
* @summary Retrieve the bank transaction
|
|
119
107
|
* @param {string} code
|
|
120
108
|
* @param {string} [authorization] Bearer Token
|
|
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
|
|
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>
|
|
122
110
|
* @param {*} [options] Override http request option.
|
|
123
111
|
* @throws {RequiredError}
|
|
124
112
|
*/
|
|
@@ -142,16 +130,6 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
142
130
|
* @throws {RequiredError}
|
|
143
131
|
*/
|
|
144
132
|
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 that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), 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>>;
|
|
155
133
|
/**
|
|
156
134
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
157
135
|
* @summary List bank transactions
|
|
@@ -161,7 +139,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
161
139
|
* @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>
|
|
162
140
|
* @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>
|
|
163
141
|
* @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>
|
|
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
|
|
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>
|
|
165
143
|
* @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>
|
|
166
144
|
* @param {*} [options] Override http request option.
|
|
167
145
|
* @throws {RequiredError}
|
|
@@ -196,7 +174,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
196
174
|
* @summary Retrieve the bank transaction
|
|
197
175
|
* @param {string} code
|
|
198
176
|
* @param {string} [authorization] Bearer Token
|
|
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
|
|
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>
|
|
200
178
|
* @param {*} [options] Override http request option.
|
|
201
179
|
* @throws {RequiredError}
|
|
202
180
|
*/
|
|
@@ -220,16 +198,6 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
220
198
|
* @throws {RequiredError}
|
|
221
199
|
*/
|
|
222
200
|
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 that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), 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>;
|
|
233
201
|
/**
|
|
234
202
|
* 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\"
|
|
235
203
|
* @summary List bank transactions
|
|
@@ -239,7 +207,7 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
239
207
|
* @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>
|
|
240
208
|
* @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>
|
|
241
209
|
* @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>
|
|
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
|
|
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>
|
|
243
211
|
* @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>
|
|
244
212
|
* @param {*} [options] Override http request option.
|
|
245
213
|
* @throws {RequiredError}
|
|
@@ -293,7 +261,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
293
261
|
*/
|
|
294
262
|
readonly authorization?: string;
|
|
295
263
|
/**
|
|
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
|
|
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>
|
|
297
265
|
* @type {string}
|
|
298
266
|
* @memberof BankTransactionApiGetBankTransaction
|
|
299
267
|
*/
|
|
@@ -343,31 +311,6 @@ export interface BankTransactionApiLinkBankTransactionRequest {
|
|
|
343
311
|
*/
|
|
344
312
|
readonly authorization?: string;
|
|
345
313
|
}
|
|
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
|
-
}
|
|
371
314
|
/**
|
|
372
315
|
* Request parameters for listBankTransactions operation in BankTransactionApi.
|
|
373
316
|
* @export
|
|
@@ -411,7 +354,7 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
411
354
|
*/
|
|
412
355
|
readonly order?: string;
|
|
413
356
|
/**
|
|
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
|
|
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>
|
|
415
358
|
* @type {string}
|
|
416
359
|
* @memberof BankTransactionApiListBankTransactions
|
|
417
360
|
*/
|
|
@@ -457,7 +400,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
457
400
|
* @throws {RequiredError}
|
|
458
401
|
* @memberof BankTransactionApi
|
|
459
402
|
*/
|
|
460
|
-
generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateInvoiceMatchSuggestionsResponseClass, any, {}
|
|
403
|
+
generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateInvoiceMatchSuggestionsResponseClass, any, {}>>;
|
|
461
404
|
/**
|
|
462
405
|
* 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\"
|
|
463
406
|
* @summary Retrieve the bank transaction
|
|
@@ -466,7 +409,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
466
409
|
* @throws {RequiredError}
|
|
467
410
|
* @memberof BankTransactionApi
|
|
468
411
|
*/
|
|
469
|
-
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any, {}
|
|
412
|
+
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any, {}>>;
|
|
470
413
|
/**
|
|
471
414
|
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
472
415
|
* @summary Create the bank transactions
|
|
@@ -475,7 +418,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
475
418
|
* @throws {RequiredError}
|
|
476
419
|
* @memberof BankTransactionApi
|
|
477
420
|
*/
|
|
478
|
-
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportBankTransactionsResponseClass, any, {}
|
|
421
|
+
importBankTransactions(requestParameters: BankTransactionApiImportBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ImportBankTransactionsResponseClass, any, {}>>;
|
|
479
422
|
/**
|
|
480
423
|
* Links a bank transaction with an invoice **Required Permissions** \"payment-management.bank-accounts.create\"
|
|
481
424
|
* @summary Link bank transaction
|
|
@@ -484,16 +427,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
484
427
|
* @throws {RequiredError}
|
|
485
428
|
* @memberof BankTransactionApi
|
|
486
429
|
*/
|
|
487
|
-
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionsResponseClass, 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 that hold no received money (no receipts, or receipts that net to zero because the money came back in a collect receipt), 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>>;
|
|
430
|
+
linkBankTransaction(requestParameters: BankTransactionApiLinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LinkBankTransactionsResponseClass, any, {}>>;
|
|
497
431
|
/**
|
|
498
432
|
* 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\"
|
|
499
433
|
* @summary List bank transactions
|
|
@@ -502,7 +436,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
502
436
|
* @throws {RequiredError}
|
|
503
437
|
* @memberof BankTransactionApi
|
|
504
438
|
*/
|
|
505
|
-
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any, {}
|
|
439
|
+
listBankTransactions(requestParameters?: BankTransactionApiListBankTransactionsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListBankTransactionsResponseClass, any, {}>>;
|
|
506
440
|
/**
|
|
507
441
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
508
442
|
* @summary Unlink bank transaction
|
|
@@ -511,5 +445,5 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
511
445
|
* @throws {RequiredError}
|
|
512
446
|
* @memberof BankTransactionApi
|
|
513
447
|
*/
|
|
514
|
-
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnlinkBankTransactionsResponseClass, any, {}
|
|
448
|
+
unlinkBankTransaction(requestParameters: BankTransactionApiUnlinkBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnlinkBankTransactionsResponseClass, any, {}>>;
|
|
515
449
|
}
|