@emilgroup/payment-sdk-node 1.21.1-beta.5 → 1.21.1-beta.50
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 +11 -0
- package/README.md +2 -2
- package/api/bank-accounts-api.ts +55 -13
- package/api/bank-orders-api.ts +695 -0
- package/api/bank-transaction-api.ts +72 -44
- 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 -4
- 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 +646 -0
- package/dist/api/bank-transaction-api.d.ts +55 -37
- package/dist/api/bank-transaction-api.js +47 -35
- 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 +11 -2
- package/dist/base.js +42 -3
- 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-without-expand-properties.d.ts +18 -14
- package/dist/models/bank-transaction-class-without-expand-properties.js +5 -0
- package/dist/models/bank-transaction-class.d.ts +18 -0
- package/dist/models/bank-transaction-class.js +5 -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/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 +10 -0
- package/dist/models/index.js +10 -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/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/unlinked-bank-transaction-response-class.d.ts +18 -14
- package/dist/models/unlinked-bank-transaction-response-class.js +5 -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-without-expand-properties.ts +21 -14
- package/models/bank-transaction-class.ts +21 -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/get-bank-order-response-class.ts +31 -0
- package/models/index.ts +10 -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/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/unlinked-bank-transaction-response-class.ts +21 -14
- 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
|
@@ -26,7 +26,7 @@ import { UnlinkBankTransactionsResponseClass } from '../models';
|
|
|
26
26
|
*/
|
|
27
27
|
export declare const BankTransactionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
28
|
/**
|
|
29
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
29
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
30
30
|
* @summary Invoice Match Suggestion
|
|
31
31
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
32
32
|
* @param {string} [authorization] Bearer Token
|
|
@@ -39,15 +39,15 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
39
39
|
* @summary Retrieve the bank transaction
|
|
40
40
|
* @param {string} code
|
|
41
41
|
* @param {string} [authorization] Bearer Token
|
|
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>
|
|
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, linkedBankOrder<i>
|
|
43
43
|
* @param {*} [options] Override http request option.
|
|
44
44
|
* @throws {RequiredError}
|
|
45
45
|
*/
|
|
46
46
|
getBankTransaction: (code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47
47
|
/**
|
|
48
|
-
* 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\"
|
|
49
49
|
* @summary Create the bank transactions
|
|
50
|
-
* @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
|
|
51
51
|
* @param {string} [authorization] Bearer Token
|
|
52
52
|
* @param {*} [options] Override http request option.
|
|
53
53
|
* @throws {RequiredError}
|
|
@@ -67,15 +67,17 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
67
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\"
|
|
68
68
|
* @summary List bank transactions
|
|
69
69
|
* @param {string} [authorization] Bearer Token
|
|
70
|
-
* @param {
|
|
71
|
-
* @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>
|
|
72
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>
|
|
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,
|
|
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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<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, linkedBankOrder<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>
|
|
75
77
|
* @param {*} [options] Override http request option.
|
|
76
78
|
* @throws {RequiredError}
|
|
77
79
|
*/
|
|
78
|
-
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>;
|
|
79
81
|
/**
|
|
80
82
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
81
83
|
* @summary Unlink bank transaction
|
|
@@ -93,7 +95,7 @@ export declare const BankTransactionApiAxiosParamCreator: (configuration?: Confi
|
|
|
93
95
|
*/
|
|
94
96
|
export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
95
97
|
/**
|
|
96
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
98
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
99
|
* @summary Invoice Match Suggestion
|
|
98
100
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
99
101
|
* @param {string} [authorization] Bearer Token
|
|
@@ -106,15 +108,15 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
106
108
|
* @summary Retrieve the bank transaction
|
|
107
109
|
* @param {string} code
|
|
108
110
|
* @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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<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, linkedBankOrder<i>
|
|
110
112
|
* @param {*} [options] Override http request option.
|
|
111
113
|
* @throws {RequiredError}
|
|
112
114
|
*/
|
|
113
115
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetBankTransactionsResponseClass>>;
|
|
114
116
|
/**
|
|
115
|
-
* 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\"
|
|
116
118
|
* @summary Create the bank transactions
|
|
117
|
-
* @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
|
|
118
120
|
* @param {string} [authorization] Bearer Token
|
|
119
121
|
* @param {*} [options] Override http request option.
|
|
120
122
|
* @throws {RequiredError}
|
|
@@ -134,15 +136,17 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
134
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\"
|
|
135
137
|
* @summary List bank transactions
|
|
136
138
|
* @param {string} [authorization] Bearer Token
|
|
137
|
-
* @param {
|
|
138
|
-
* @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>
|
|
139
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>
|
|
140
|
-
* @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,
|
|
141
|
-
* @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>
|
|
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, linkedBankOrder<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>
|
|
142
146
|
* @param {*} [options] Override http request option.
|
|
143
147
|
* @throws {RequiredError}
|
|
144
148
|
*/
|
|
145
|
-
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>>;
|
|
146
150
|
/**
|
|
147
151
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
148
152
|
* @summary Unlink bank transaction
|
|
@@ -160,7 +164,7 @@ export declare const BankTransactionApiFp: (configuration?: Configuration) => {
|
|
|
160
164
|
*/
|
|
161
165
|
export declare const BankTransactionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
162
166
|
/**
|
|
163
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
167
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
164
168
|
* @summary Invoice Match Suggestion
|
|
165
169
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
166
170
|
* @param {string} [authorization] Bearer Token
|
|
@@ -173,15 +177,15 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
173
177
|
* @summary Retrieve the bank transaction
|
|
174
178
|
* @param {string} code
|
|
175
179
|
* @param {string} [authorization] Bearer Token
|
|
176
|
-
* @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>
|
|
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, linkedBankOrder<i>
|
|
177
181
|
* @param {*} [options] Override http request option.
|
|
178
182
|
* @throws {RequiredError}
|
|
179
183
|
*/
|
|
180
184
|
getBankTransaction(code: string, authorization?: string, expand?: string, options?: any): AxiosPromise<GetBankTransactionsResponseClass>;
|
|
181
185
|
/**
|
|
182
|
-
* 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\"
|
|
183
187
|
* @summary Create the bank transactions
|
|
184
|
-
* @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
|
|
185
189
|
* @param {string} [authorization] Bearer Token
|
|
186
190
|
* @param {*} [options] Override http request option.
|
|
187
191
|
* @throws {RequiredError}
|
|
@@ -201,15 +205,17 @@ export declare const BankTransactionApiFactory: (configuration?: Configuration,
|
|
|
201
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\"
|
|
202
206
|
* @summary List bank transactions
|
|
203
207
|
* @param {string} [authorization] Bearer Token
|
|
204
|
-
* @param {
|
|
205
|
-
* @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>
|
|
206
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>
|
|
207
|
-
* @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,
|
|
208
|
-
* @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>
|
|
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, linkedBankOrder<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>
|
|
209
215
|
* @param {*} [options] Override http request option.
|
|
210
216
|
* @throws {RequiredError}
|
|
211
217
|
*/
|
|
212
|
-
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>;
|
|
213
219
|
/**
|
|
214
220
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
215
221
|
* @summary Unlink bank transaction
|
|
@@ -259,7 +265,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
259
265
|
*/
|
|
260
266
|
readonly authorization?: string;
|
|
261
267
|
/**
|
|
262
|
-
* 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>
|
|
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, linkedBankOrder<i>
|
|
263
269
|
* @type {string}
|
|
264
270
|
* @memberof BankTransactionApiGetBankTransaction
|
|
265
271
|
*/
|
|
@@ -272,7 +278,7 @@ export interface BankTransactionApiGetBankTransactionRequest {
|
|
|
272
278
|
*/
|
|
273
279
|
export interface BankTransactionApiImportBankTransactionsRequest {
|
|
274
280
|
/**
|
|
275
|
-
*
|
|
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
|
|
276
282
|
* @type {any}
|
|
277
283
|
* @memberof BankTransactionApiImportBankTransactions
|
|
278
284
|
*/
|
|
@@ -322,17 +328,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
322
328
|
*/
|
|
323
329
|
readonly authorization?: string;
|
|
324
330
|
/**
|
|
325
|
-
*
|
|
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.
|
|
326
338
|
* @type {string}
|
|
327
339
|
* @memberof BankTransactionApiListBankTransactions
|
|
328
340
|
*/
|
|
329
|
-
readonly
|
|
341
|
+
readonly pageToken?: string;
|
|
330
342
|
/**
|
|
331
|
-
*
|
|
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>
|
|
332
344
|
* @type {string}
|
|
333
345
|
* @memberof BankTransactionApiListBankTransactions
|
|
334
346
|
*/
|
|
335
|
-
readonly
|
|
347
|
+
readonly filter?: string;
|
|
336
348
|
/**
|
|
337
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>
|
|
338
350
|
* @type {string}
|
|
@@ -340,17 +352,23 @@ export interface BankTransactionApiListBankTransactionsRequest {
|
|
|
340
352
|
*/
|
|
341
353
|
readonly search?: string;
|
|
342
354
|
/**
|
|
343
|
-
* 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>
|
|
344
356
|
* @type {string}
|
|
345
357
|
* @memberof BankTransactionApiListBankTransactions
|
|
346
358
|
*/
|
|
347
359
|
readonly order?: string;
|
|
348
360
|
/**
|
|
349
|
-
* 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>
|
|
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, linkedBankOrder<i>
|
|
350
362
|
* @type {string}
|
|
351
363
|
* @memberof BankTransactionApiListBankTransactions
|
|
352
364
|
*/
|
|
353
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;
|
|
354
372
|
}
|
|
355
373
|
/**
|
|
356
374
|
* Request parameters for unlinkBankTransaction operation in BankTransactionApi.
|
|
@@ -385,7 +403,7 @@ export interface BankTransactionApiUnlinkBankTransactionRequest {
|
|
|
385
403
|
*/
|
|
386
404
|
export declare class BankTransactionApi extends BaseAPI {
|
|
387
405
|
/**
|
|
388
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
406
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
389
407
|
* @summary Invoice Match Suggestion
|
|
390
408
|
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
391
409
|
* @param {*} [options] Override http request option.
|
|
@@ -403,7 +421,7 @@ export declare class BankTransactionApi extends BaseAPI {
|
|
|
403
421
|
*/
|
|
404
422
|
getBankTransaction(requestParameters: BankTransactionApiGetBankTransactionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetBankTransactionsResponseClass, any>>;
|
|
405
423
|
/**
|
|
406
|
-
* 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\"
|
|
407
425
|
* @summary Create the bank transactions
|
|
408
426
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
409
427
|
* @param {*} [options] Override http request option.
|
|
@@ -97,7 +97,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
97
97
|
var _this = this;
|
|
98
98
|
return {
|
|
99
99
|
/**
|
|
100
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
100
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
101
101
|
* @summary Invoice Match Suggestion
|
|
102
102
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
103
103
|
* @param {string} [authorization] Bearer Token
|
|
@@ -149,7 +149,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
149
149
|
* @summary Retrieve the bank transaction
|
|
150
150
|
* @param {string} code
|
|
151
151
|
* @param {string} [authorization] Bearer Token
|
|
152
|
-
* @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>
|
|
152
|
+
* @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, linkedBankOrder<i>
|
|
153
153
|
* @param {*} [options] Override http request option.
|
|
154
154
|
* @throws {RequiredError}
|
|
155
155
|
*/
|
|
@@ -197,9 +197,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
197
197
|
});
|
|
198
198
|
},
|
|
199
199
|
/**
|
|
200
|
-
* This will import bank transactions from a
|
|
200
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
201
201
|
* @summary Create the bank transactions
|
|
202
|
-
* @param {any} file
|
|
202
|
+
* @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
|
|
203
203
|
* @param {string} [authorization] Bearer Token
|
|
204
204
|
* @param {*} [options] Override http request option.
|
|
205
205
|
* @throws {RequiredError}
|
|
@@ -306,15 +306,17 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
306
306
|
* 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\"
|
|
307
307
|
* @summary List bank transactions
|
|
308
308
|
* @param {string} [authorization] Bearer Token
|
|
309
|
-
* @param {
|
|
310
|
-
* @param {string} [
|
|
309
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
310
|
+
* @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.
|
|
311
|
+
* @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>
|
|
311
312
|
* @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>
|
|
312
|
-
* @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,
|
|
313
|
-
* @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>
|
|
313
|
+
* @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>
|
|
314
|
+
* @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, linkedBankOrder<i>
|
|
315
|
+
* @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>
|
|
314
316
|
* @param {*} [options] Override http request option.
|
|
315
317
|
* @throws {RequiredError}
|
|
316
318
|
*/
|
|
317
|
-
listBankTransactions: function (authorization,
|
|
319
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
318
320
|
if (options === void 0) { options = {}; }
|
|
319
321
|
return __awaiter(_this, void 0, void 0, function () {
|
|
320
322
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -337,12 +339,15 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
337
339
|
// authentication bearer required
|
|
338
340
|
// http bearer authentication required
|
|
339
341
|
_a.sent();
|
|
342
|
+
if (pageSize !== undefined) {
|
|
343
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
344
|
+
}
|
|
345
|
+
if (pageToken !== undefined) {
|
|
346
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
347
|
+
}
|
|
340
348
|
if (filter !== undefined) {
|
|
341
349
|
localVarQueryParameter['filter'] = filter;
|
|
342
350
|
}
|
|
343
|
-
if (filters !== undefined) {
|
|
344
|
-
localVarQueryParameter['filters'] = filters;
|
|
345
|
-
}
|
|
346
351
|
if (search !== undefined) {
|
|
347
352
|
localVarQueryParameter['search'] = search;
|
|
348
353
|
}
|
|
@@ -352,6 +357,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
352
357
|
if (expand !== undefined) {
|
|
353
358
|
localVarQueryParameter['expand'] = expand;
|
|
354
359
|
}
|
|
360
|
+
if (filters !== undefined) {
|
|
361
|
+
localVarQueryParameter['filters'] = filters;
|
|
362
|
+
}
|
|
355
363
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
356
364
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
357
365
|
}
|
|
@@ -430,7 +438,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
430
438
|
var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
|
|
431
439
|
return {
|
|
432
440
|
/**
|
|
433
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
441
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
434
442
|
* @summary Invoice Match Suggestion
|
|
435
443
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
436
444
|
* @param {string} [authorization] Bearer Token
|
|
@@ -455,7 +463,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
455
463
|
* @summary Retrieve the bank transaction
|
|
456
464
|
* @param {string} code
|
|
457
465
|
* @param {string} [authorization] Bearer Token
|
|
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, transaction, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
466
|
+
* @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, linkedBankOrder<i>
|
|
459
467
|
* @param {*} [options] Override http request option.
|
|
460
468
|
* @throws {RequiredError}
|
|
461
469
|
*/
|
|
@@ -473,9 +481,9 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
473
481
|
});
|
|
474
482
|
},
|
|
475
483
|
/**
|
|
476
|
-
* This will import bank transactions from a
|
|
484
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
477
485
|
* @summary Create the bank transactions
|
|
478
|
-
* @param {any} file
|
|
486
|
+
* @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
|
|
479
487
|
* @param {string} [authorization] Bearer Token
|
|
480
488
|
* @param {*} [options] Override http request option.
|
|
481
489
|
* @throws {RequiredError}
|
|
@@ -519,20 +527,22 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
519
527
|
* 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\"
|
|
520
528
|
* @summary List bank transactions
|
|
521
529
|
* @param {string} [authorization] Bearer Token
|
|
522
|
-
* @param {
|
|
523
|
-
* @param {string} [
|
|
530
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
531
|
+
* @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.
|
|
532
|
+
* @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>
|
|
524
533
|
* @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>
|
|
525
|
-
* @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,
|
|
526
|
-
* @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>
|
|
534
|
+
* @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>
|
|
535
|
+
* @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, linkedBankOrder<i>
|
|
536
|
+
* @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>
|
|
527
537
|
* @param {*} [options] Override http request option.
|
|
528
538
|
* @throws {RequiredError}
|
|
529
539
|
*/
|
|
530
|
-
listBankTransactions: function (authorization,
|
|
540
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
531
541
|
return __awaiter(this, void 0, void 0, function () {
|
|
532
542
|
var localVarAxiosArgs;
|
|
533
543
|
return __generator(this, function (_a) {
|
|
534
544
|
switch (_a.label) {
|
|
535
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization,
|
|
545
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
536
546
|
case 1:
|
|
537
547
|
localVarAxiosArgs = _a.sent();
|
|
538
548
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -573,7 +583,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
573
583
|
var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
|
|
574
584
|
return {
|
|
575
585
|
/**
|
|
576
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
586
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
577
587
|
* @summary Invoice Match Suggestion
|
|
578
588
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
579
589
|
* @param {string} [authorization] Bearer Token
|
|
@@ -588,7 +598,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
588
598
|
* @summary Retrieve the bank transaction
|
|
589
599
|
* @param {string} code
|
|
590
600
|
* @param {string} [authorization] Bearer Token
|
|
591
|
-
* @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>
|
|
601
|
+
* @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, linkedBankOrder<i>
|
|
592
602
|
* @param {*} [options] Override http request option.
|
|
593
603
|
* @throws {RequiredError}
|
|
594
604
|
*/
|
|
@@ -596,9 +606,9 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
596
606
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
597
607
|
},
|
|
598
608
|
/**
|
|
599
|
-
* This will import bank transactions from a
|
|
609
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
600
610
|
* @summary Create the bank transactions
|
|
601
|
-
* @param {any} file
|
|
611
|
+
* @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
|
|
602
612
|
* @param {string} [authorization] Bearer Token
|
|
603
613
|
* @param {*} [options] Override http request option.
|
|
604
614
|
* @throws {RequiredError}
|
|
@@ -622,16 +632,18 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
622
632
|
* 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\"
|
|
623
633
|
* @summary List bank transactions
|
|
624
634
|
* @param {string} [authorization] Bearer Token
|
|
625
|
-
* @param {
|
|
626
|
-
* @param {string} [
|
|
635
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
636
|
+
* @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.
|
|
637
|
+
* @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>
|
|
627
638
|
* @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>
|
|
628
|
-
* @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,
|
|
629
|
-
* @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>
|
|
639
|
+
* @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>
|
|
640
|
+
* @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, linkedBankOrder<i>
|
|
641
|
+
* @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>
|
|
630
642
|
* @param {*} [options] Override http request option.
|
|
631
643
|
* @throws {RequiredError}
|
|
632
644
|
*/
|
|
633
|
-
listBankTransactions: function (authorization,
|
|
634
|
-
return localVarFp.listBankTransactions(authorization,
|
|
645
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
646
|
+
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
635
647
|
},
|
|
636
648
|
/**
|
|
637
649
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
@@ -660,7 +672,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
660
672
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
661
673
|
}
|
|
662
674
|
/**
|
|
663
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
675
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
664
676
|
* @summary Invoice Match Suggestion
|
|
665
677
|
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
666
678
|
* @param {*} [options] Override http request option.
|
|
@@ -684,7 +696,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
684
696
|
return (0, exports.BankTransactionApiFp)(this.configuration).getBankTransaction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
685
697
|
};
|
|
686
698
|
/**
|
|
687
|
-
* This will import bank transactions from a
|
|
699
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
688
700
|
* @summary Create the bank transactions
|
|
689
701
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
690
702
|
* @param {*} [options] Override http request option.
|
|
@@ -718,7 +730,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
718
730
|
BankTransactionApi.prototype.listBankTransactions = function (requestParameters, options) {
|
|
719
731
|
var _this = this;
|
|
720
732
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
721
|
-
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.
|
|
733
|
+
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
722
734
|
};
|
|
723
735
|
/**
|
|
724
736
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|