@emilgroup/payment-sdk 1.13.1-beta.4 → 1.13.1-beta.41
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 +14 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +691 -0
- package/api/bank-transaction-api.ts +171 -40
- package/api/payment-methods-api.ts +59 -17
- package/api/payment-reminders-api.ts +55 -13
- package/api/payments-api.ts +59 -17
- package/api/refunds-api.ts +45 -17
- package/api/tenant-bank-account-api.ts +45 -17
- package/api.ts +2 -0
- package/base.ts +46 -2
- package/dist/api/bank-accounts-api.d.ts +35 -8
- package/dist/api/bank-accounts-api.js +29 -11
- package/dist/api/bank-orders-api.d.ts +393 -0
- package/dist/api/bank-orders-api.js +642 -0
- package/dist/api/bank-transaction-api.d.ts +107 -33
- package/dist/api/bank-transaction-api.js +135 -31
- package/dist/api/payment-methods-api.d.ts +39 -12
- package/dist/api/payment-methods-api.js +32 -14
- package/dist/api/payment-reminders-api.d.ts +35 -8
- package/dist/api/payment-reminders-api.js +29 -11
- package/dist/api/payments-api.d.ts +39 -12
- package/dist/api/payments-api.js +32 -14
- package/dist/api/refunds-api.d.ts +28 -10
- package/dist/api/refunds-api.js +24 -12
- package/dist/api/tenant-bank-account-api.d.ts +28 -10
- package/dist/api/tenant-bank-account-api.js +24 -12
- package/dist/api.d.ts +1 -0
- package/dist/api.js +1 -0
- package/dist/base.d.ts +10 -1
- package/dist/base.js +41 -1
- package/dist/models/bank-order-class.d.ts +115 -0
- package/dist/models/bank-order-class.js +15 -0
- package/dist/models/bank-transaction-class.d.ts +14 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.d.ts +1 -0
- package/dist/models/complete-adyen-payment-setup-request-dto.js +2 -1
- package/dist/models/complete-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/complete-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/complete-payment-setup-request-dto.d.ts +7 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.d.ts +1 -0
- package/dist/models/complete-stripe-payment-setup-request-dto.js +2 -1
- package/dist/models/create-bank-order-request-dto.d.ts +74 -0
- package/dist/models/create-bank-order-request-dto.js +28 -0
- package/dist/models/create-bank-order-response-class.d.ts +25 -0
- package/dist/models/create-bank-order-response-class.js +15 -0
- package/dist/models/create-payment-reminder-request-dto.d.ts +7 -1
- package/dist/models/create-payment-request-dto.d.ts +7 -1
- package/dist/models/create-psp-payment-method-request-dto.d.ts +14 -1
- package/dist/models/create-psp-payment-method-request-dto.js +2 -1
- package/dist/models/deactivated-payment-reminder-class.d.ts +7 -1
- package/dist/models/financial-account-class.d.ts +111 -0
- package/dist/models/financial-account-class.js +24 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.d.ts +25 -0
- package/dist/models/generate-invoice-match-suggestions-response-class.js +15 -0
- package/dist/models/get-bank-order-response-class.d.ts +25 -0
- package/dist/models/get-bank-order-response-class.js +15 -0
- package/dist/models/index.d.ts +13 -0
- package/dist/models/index.js +13 -0
- package/dist/models/initiate-adyen-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-braintree-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.d.ts +36 -0
- package/dist/models/initiate-eis-payment-setup-request-dto.js +15 -0
- package/dist/models/initiate-payment-setup-request-dto.d.ts +3 -2
- package/dist/models/initiate-stripe-payment-setup-request-dto.d.ts +6 -0
- package/dist/models/invoice-match-suggestion-class.d.ts +60 -0
- package/dist/models/invoice-match-suggestion-class.js +15 -0
- package/dist/models/list-bank-orders-response-class.d.ts +31 -0
- package/dist/models/list-bank-orders-response-class.js +15 -0
- package/dist/models/payment-class-without-expand-properties.d.ts +7 -1
- package/dist/models/payment-class.d.ts +7 -1
- package/dist/models/payment-method-class.d.ts +6 -0
- package/dist/models/payment-reminder-class.d.ts +7 -1
- package/dist/models/refund-class.d.ts +7 -1
- package/dist/models/suggestion-generation-progress-class.d.ts +43 -0
- package/dist/models/suggestion-generation-progress-class.js +22 -0
- package/dist/models/update-bank-order-request-dto.d.ts +56 -0
- package/dist/models/update-bank-order-request-dto.js +23 -0
- package/dist/models/update-bank-order-response-class.d.ts +25 -0
- package/dist/models/update-bank-order-response-class.js +15 -0
- package/models/bank-order-class.ts +121 -0
- package/models/bank-transaction-class.ts +14 -0
- package/models/complete-adyen-payment-setup-request-dto.ts +2 -1
- package/models/complete-eis-payment-setup-request-dto.ts +42 -0
- package/models/complete-payment-setup-request-dto.ts +7 -0
- package/models/complete-stripe-payment-setup-request-dto.ts +2 -1
- package/models/create-bank-order-request-dto.ts +84 -0
- package/models/create-bank-order-response-class.ts +31 -0
- package/models/create-payment-reminder-request-dto.ts +7 -1
- package/models/create-payment-request-dto.ts +7 -1
- package/models/create-psp-payment-method-request-dto.ts +15 -2
- package/models/deactivated-payment-reminder-class.ts +7 -1
- package/models/financial-account-class.ts +120 -0
- package/models/generate-invoice-match-suggestions-response-class.ts +31 -0
- package/models/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +13 -0
- package/models/initiate-adyen-payment-setup-request-dto.ts +6 -0
- package/models/initiate-braintree-payment-setup-request-dto.ts +6 -0
- package/models/initiate-eis-payment-setup-request-dto.ts +42 -0
- package/models/initiate-payment-setup-request-dto.ts +3 -2
- package/models/initiate-stripe-payment-setup-request-dto.ts +6 -0
- package/models/invoice-match-suggestion-class.ts +66 -0
- package/models/list-bank-orders-response-class.ts +37 -0
- package/models/payment-class-without-expand-properties.ts +7 -1
- package/models/payment-class.ts +7 -1
- package/models/payment-method-class.ts +6 -0
- package/models/payment-reminder-class.ts +7 -1
- package/models/refund-class.ts +7 -1
- package/models/suggestion-generation-progress-class.ts +52 -0
- package/models/update-bank-order-request-dto.ts +65 -0
- package/models/update-bank-order-response-class.ts +31 -0
- package/package.json +1 -1
- package/tsconfig.json +1 -0
|
@@ -12,6 +12,7 @@
|
|
|
12
12
|
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
13
13
|
import { Configuration } from '../configuration';
|
|
14
14
|
import { RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import { GenerateInvoiceMatchSuggestionsResponseClass } from '../models';
|
|
15
16
|
import { GetBankTransactionsResponseClass } from '../models';
|
|
16
17
|
import { ImportBankTransactionsResponseClass } from '../models';
|
|
17
18
|
import { LinkBankTransactionRequestDtoRest } from '../models';
|
|
@@ -24,20 +25,29 @@ import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
|
24
25
|
* @export
|
|
25
26
|
*/
|
|
26
27
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
|
+
/**
|
|
29
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
30
|
+
* @summary Invoice Match Suggestion
|
|
31
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
32
|
+
* @param {string} [authorization] Bearer Token
|
|
33
|
+
* @param {*} [options] Override http request option.
|
|
34
|
+
* @throws {RequiredError}
|
|
35
|
+
*/
|
|
36
|
+
generateInvoiceMatchSuggestion: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
27
37
|
/**
|
|
28
38
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
29
39
|
* @summary Retrieve the bank transaction
|
|
30
40
|
* @param {string} code
|
|
31
41
|
* @param {string} [authorization] Bearer Token
|
|
32
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
42
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
33
43
|
* @param {*} [options] Override http request option.
|
|
34
44
|
* @throws {RequiredError}
|
|
35
45
|
*/
|
|
36
46
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
47
|
/**
|
|
38
|
-
* This will import bank transactions from a
|
|
48
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
39
49
|
* @summary Create the bank transactions
|
|
40
|
-
* @param {any} file
|
|
50
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
41
51
|
* @param {string} [authorization] Bearer Token
|
|
42
52
|
* @param {*} [options] Override http request option.
|
|
43
53
|
* @throws {RequiredError}
|
|
@@ -57,15 +67,17 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
57
67
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
58
68
|
* @summary List bank transactions
|
|
59
69
|
* @param {string} [authorization] Bearer Token
|
|
60
|
-
* @param {
|
|
61
|
-
* @param {string} [
|
|
70
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
71
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
72
|
+
* @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>
|
|
62
73
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
63
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
64
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
74
|
+
* @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>
|
|
75
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
76
|
+
* @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>
|
|
65
77
|
* @param {*} [options] Override http request option.
|
|
66
78
|
* @throws {RequiredError}
|
|
67
79
|
*/
|
|
68
|
-
listBankTransactions: (authorization?: string,
|
|
80
|
+
listBankTransactions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
81
|
/**
|
|
70
82
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
71
83
|
* @summary Unlink bank transaction
|
|
@@ -82,20 +94,29 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
82
94
|
* @export
|
|
83
95
|
*/
|
|
84
96
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
97
|
+
/**
|
|
98
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
99
|
+
* @summary Invoice Match Suggestion
|
|
100
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
101
|
+
* @param {string} [authorization] Bearer Token
|
|
102
|
+
* @param {*} [options] Override http request option.
|
|
103
|
+
* @throws {RequiredError}
|
|
104
|
+
*/
|
|
105
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>>;
|
|
85
106
|
/**
|
|
86
107
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
87
108
|
* @summary Retrieve the bank transaction
|
|
88
109
|
* @param {string} code
|
|
89
110
|
* @param {string} [authorization] Bearer Token
|
|
90
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
111
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
91
112
|
* @param {*} [options] Override http request option.
|
|
92
113
|
* @throws {RequiredError}
|
|
93
114
|
*/
|
|
94
115
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
95
116
|
/**
|
|
96
|
-
* This will import bank transactions from a
|
|
117
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
118
|
* @summary Create the bank transactions
|
|
98
|
-
* @param {any} file
|
|
119
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
99
120
|
* @param {string} [authorization] Bearer Token
|
|
100
121
|
* @param {*} [options] Override http request option.
|
|
101
122
|
* @throws {RequiredError}
|
|
@@ -115,15 +136,17 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
115
136
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
116
137
|
* @summary List bank transactions
|
|
117
138
|
* @param {string} [authorization] Bearer Token
|
|
118
|
-
* @param {
|
|
119
|
-
* @param {string} [
|
|
139
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
140
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
141
|
+
* @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>
|
|
120
142
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
121
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
122
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
143
|
+
* @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>
|
|
144
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
145
|
+
* @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>
|
|
123
146
|
* @param {*} [options] Override http request option.
|
|
124
147
|
* @throws {RequiredError}
|
|
125
148
|
*/
|
|
126
|
-
listBankTransactions(authorization?: string,
|
|
149
|
+
listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListBankTransactionsResponseClass>>;
|
|
127
150
|
/**
|
|
128
151
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
129
152
|
* @summary Unlink bank transaction
|
|
@@ -140,20 +163,29 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
140
163
|
* @export
|
|
141
164
|
*/
|
|
142
165
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
166
|
+
/**
|
|
167
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
168
|
+
* @summary Invoice Match Suggestion
|
|
169
|
+
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
170
|
+
* @param {string} [authorization] Bearer Token
|
|
171
|
+
* @param {*} [options] Override http request option.
|
|
172
|
+
* @throws {RequiredError}
|
|
173
|
+
*/
|
|
174
|
+
generateInvoiceMatchSuggestion(code: string, authorization?: string, options?: any): AxiosPromise<GenerateInvoiceMatchSuggestionsResponseClass>;
|
|
143
175
|
/**
|
|
144
176
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
145
177
|
* @summary Retrieve the bank transaction
|
|
146
178
|
* @param {string} code
|
|
147
179
|
* @param {string} [authorization] Bearer Token
|
|
148
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
180
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
149
181
|
* @param {*} [options] Override http request option.
|
|
150
182
|
* @throws {RequiredError}
|
|
151
183
|
*/
|
|
152
184
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
153
185
|
/**
|
|
154
|
-
* This will import bank transactions from a
|
|
186
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
155
187
|
* @summary Create the bank transactions
|
|
156
|
-
* @param {any} file
|
|
188
|
+
* @param {any} file MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
157
189
|
* @param {string} [authorization] Bearer Token
|
|
158
190
|
* @param {*} [options] Override http request option.
|
|
159
191
|
* @throws {RequiredError}
|
|
@@ -173,15 +205,17 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
173
205
|
* Returns a list of bank transactions you have previously created. The bank transactions are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
174
206
|
* @summary List bank transactions
|
|
175
207
|
* @param {string} [authorization] Bearer Token
|
|
176
|
-
* @param {
|
|
177
|
-
* @param {string} [
|
|
208
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
209
|
+
* @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
210
|
+
* @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>
|
|
178
211
|
* @param {string} [search] Search the response for matches in any searchable field. Use filter instead where possible for improved performance.<br/> <br/> <i>Searchable fields: id, createdAt, amount</i>
|
|
179
|
-
* @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
180
|
-
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
212
|
+
* @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>
|
|
213
|
+
* @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
214
|
+
* @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>
|
|
181
215
|
* @param {*} [options] Override http request option.
|
|
182
216
|
* @throws {RequiredError}
|
|
183
217
|
*/
|
|
184
|
-
listBankTransactions(authorization?: string,
|
|
218
|
+
listBankTransactions(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListBankTransactionsResponseClass>;
|
|
185
219
|
/**
|
|
186
220
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
187
221
|
* @summary Unlink bank transaction
|
|
@@ -193,6 +227,25 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
193
227
|
*/
|
|
194
228
|
unlinkBankTransaction(code: string, unlinkBankTransactionRequestDtoRest: UnlinkBankTransactionRequestDtoRest, authorization?: string, options?: any): AxiosPromise<UnlinkBankTransactionsResponseClass>;
|
|
195
229
|
};
|
|
230
|
+
/**
|
|
231
|
+
* Request parameters for generateInvoiceMatchSuggestion operation in BankTransactionApi.
|
|
232
|
+
* @export
|
|
233
|
+
* @interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest
|
|
234
|
+
*/
|
|
235
|
+
export interface BankTransactionApiGenerateInvoiceMatchSuggestionRequest {
|
|
236
|
+
/**
|
|
237
|
+
* Code of the bank transaction to generate match suggestions for
|
|
238
|
+
* @type {string}
|
|
239
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
240
|
+
*/
|
|
241
|
+
readonly code: string;
|
|
242
|
+
/**
|
|
243
|
+
* Bearer Token
|
|
244
|
+
* @type {string}
|
|
245
|
+
* @memberof BankTransactionApiGenerateInvoiceMatchSuggestion
|
|
246
|
+
*/
|
|
247
|
+
readonly authorization?: string;
|
|
248
|
+
}
|
|
196
249
|
/**
|
|
197
250
|
* Request parameters for getBankTransaction operation in BankTransactionApi.
|
|
198
251
|
* @export
|
|
@@ -212,7 +265,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
212
265
|
*/
|
|
213
266
|
readonly authorization?: string;
|
|
214
267
|
/**
|
|
215
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
268
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
216
269
|
* @type {string}
|
|
217
270
|
* @memberof BankTransactionApiGetBankTransaction
|
|
218
271
|
*/
|
|
@@ -225,7 +278,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
225
278
|
*/
|
|
226
279
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
227
280
|
/**
|
|
228
|
-
*
|
|
281
|
+
* MT940/CAMT.053 file to import bank transactions from. Extension must be .txt .sta or .xml.<br/> Allowed Content Types: text/plain, application/octet-stream, application/xml, text/xml
|
|
229
282
|
* @type {any}
|
|
230
283
|
* @memberof BankTransactionApiImportBankTransactions
|
|
231
284
|
*/
|
|
@@ -275,17 +328,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
275
328
|
*/
|
|
276
329
|
readonly authorization?: string;
|
|
277
330
|
/**
|
|
278
|
-
*
|
|
331
|
+
* A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
332
|
+
* @type {number}
|
|
333
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
334
|
+
*/
|
|
335
|
+
readonly pageSize?: number;
|
|
336
|
+
/**
|
|
337
|
+
* A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
|
|
279
338
|
* @type {string}
|
|
280
339
|
* @memberof BankTransactionApiListBankTransactions
|
|
281
340
|
*/
|
|
282
|
-
readonly
|
|
341
|
+
readonly pageToken?: string;
|
|
283
342
|
/**
|
|
284
|
-
*
|
|
343
|
+
* 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>
|
|
285
344
|
* @type {string}
|
|
286
345
|
* @memberof BankTransactionApiListBankTransactions
|
|
287
346
|
*/
|
|
288
|
-
readonly
|
|
347
|
+
readonly filter?: string;
|
|
289
348
|
/**
|
|
290
349
|
* 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>
|
|
291
350
|
* @type {string}
|
|
@@ -293,17 +352,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
293
352
|
*/
|
|
294
353
|
readonly search?: string;
|
|
295
354
|
/**
|
|
296
|
-
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt,
|
|
355
|
+
* Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.<br/> <br/> <i>Allowed values: id, createdAt, transactionDate, entryDate</i>
|
|
297
356
|
* @type {string}
|
|
298
357
|
* @memberof BankTransactionApiListBankTransactions
|
|
299
358
|
*/
|
|
300
359
|
readonly order?: string;
|
|
301
360
|
/**
|
|
302
|
-
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction<i>
|
|
361
|
+
* Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.<br/> <br/> <i>Allowed values: bankAccount, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
303
362
|
* @type {string}
|
|
304
363
|
* @memberof BankTransactionApiListBankTransactions
|
|
305
364
|
*/
|
|
306
365
|
readonly expand?: string;
|
|
366
|
+
/**
|
|
367
|
+
* 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>
|
|
368
|
+
* @type {string}
|
|
369
|
+
* @memberof BankTransactionApiListBankTransactions
|
|
370
|
+
*/
|
|
371
|
+
readonly filters?: string;
|
|
307
372
|
}
|
|
308
373
|
/**
|
|
309
374
|
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
@@ -337,6 +402,15 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
337
402
|
* @extends {BaseAPI}
|
|
338
403
|
*/
|
|
339
404
|
export declare class BankTransactionApi extends BaseAPI {
|
|
405
|
+
/**
|
|
406
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
407
|
+
* @summary Invoice Match Suggestion
|
|
408
|
+
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
409
|
+
* @param {*} [options] Override http request option.
|
|
410
|
+
* @throws {RequiredError}
|
|
411
|
+
* @memberof BankTransactionApi
|
|
412
|
+
*/
|
|
413
|
+
generateInvoiceMatchSuggestion(requestParameters: BankTransactionApiGenerateInvoiceMatchSuggestionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GenerateInvoiceMatchSuggestionsResponseClass, any>>;
|
|
340
414
|
/**
|
|
341
415
|
* Retrieves the details of the bank transaction that was previously created. Supply the unique bank transaction code that was returned when you created it and Emil Api will return the corresponding bank transaction information. **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
342
416
|
* @summary Retrieve the bank transaction
|
|
@@ -347,7 +421,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
347
421
|
*/
|
|
348
422
|
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
349
423
|
/**
|
|
350
|
-
* This will import bank transactions from a
|
|
424
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
351
425
|
* @summary Create the bank transactions
|
|
352
426
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
353
427
|
* @param {*} [options] Override http request option.
|