@emilgroup/payment-sdk 1.13.1-beta.5 → 1.13.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 +691 -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 +52 -3
- 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 +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 +10 -1
- package/dist/base.js +46 -2
- 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.
|
|
@@ -93,7 +93,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
93
93
|
var _this = this;
|
|
94
94
|
return {
|
|
95
95
|
/**
|
|
96
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
96
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
97
97
|
* @summary Invoice Match Suggestion
|
|
98
98
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
99
99
|
* @param {string} [authorization] Bearer Token
|
|
@@ -145,7 +145,7 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
145
145
|
* @summary Retrieve the bank transaction
|
|
146
146
|
* @param {string} code
|
|
147
147
|
* @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, invoiceMatchSuggestions, suggestionGenerationProgress<i>
|
|
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, invoiceMatchSuggestions, suggestionGenerationProgress, linkedBankOrder<i>
|
|
149
149
|
* @param {*} [options] Override http request option.
|
|
150
150
|
* @throws {RequiredError}
|
|
151
151
|
*/
|
|
@@ -193,9 +193,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
193
193
|
});
|
|
194
194
|
},
|
|
195
195
|
/**
|
|
196
|
-
* This will import bank transactions from a
|
|
196
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
197
197
|
* @summary Create the bank transactions
|
|
198
|
-
* @param {any} file
|
|
198
|
+
* @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
|
|
199
199
|
* @param {string} [authorization] Bearer Token
|
|
200
200
|
* @param {*} [options] Override http request option.
|
|
201
201
|
* @throws {RequiredError}
|
|
@@ -301,15 +301,17 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
301
301
|
* 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\"
|
|
302
302
|
* @summary List bank transactions
|
|
303
303
|
* @param {string} [authorization] Bearer Token
|
|
304
|
-
* @param {
|
|
305
|
-
* @param {string} [
|
|
304
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
305
|
+
* @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.
|
|
306
|
+
* @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>
|
|
306
307
|
* @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>
|
|
307
|
-
* @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,
|
|
308
|
-
* @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>
|
|
308
|
+
* @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>
|
|
309
|
+
* @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>
|
|
310
|
+
* @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>
|
|
309
311
|
* @param {*} [options] Override http request option.
|
|
310
312
|
* @throws {RequiredError}
|
|
311
313
|
*/
|
|
312
|
-
listBankTransactions: function (authorization,
|
|
314
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
313
315
|
if (options === void 0) { options = {}; }
|
|
314
316
|
return __awaiter(_this, void 0, void 0, function () {
|
|
315
317
|
var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
|
|
@@ -332,12 +334,15 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
332
334
|
// authentication bearer required
|
|
333
335
|
// http bearer authentication required
|
|
334
336
|
_a.sent();
|
|
337
|
+
if (pageSize !== undefined) {
|
|
338
|
+
localVarQueryParameter['pageSize'] = pageSize;
|
|
339
|
+
}
|
|
340
|
+
if (pageToken !== undefined) {
|
|
341
|
+
localVarQueryParameter['pageToken'] = pageToken;
|
|
342
|
+
}
|
|
335
343
|
if (filter !== undefined) {
|
|
336
344
|
localVarQueryParameter['filter'] = filter;
|
|
337
345
|
}
|
|
338
|
-
if (filters !== undefined) {
|
|
339
|
-
localVarQueryParameter['filters'] = filters;
|
|
340
|
-
}
|
|
341
346
|
if (search !== undefined) {
|
|
342
347
|
localVarQueryParameter['search'] = search;
|
|
343
348
|
}
|
|
@@ -347,6 +352,9 @@ var BankTransactionApiAxiosParamCreator = function (configuration) {
|
|
|
347
352
|
if (expand !== undefined) {
|
|
348
353
|
localVarQueryParameter['expand'] = expand;
|
|
349
354
|
}
|
|
355
|
+
if (filters !== undefined) {
|
|
356
|
+
localVarQueryParameter['filters'] = filters;
|
|
357
|
+
}
|
|
350
358
|
if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
|
|
351
359
|
localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
|
|
352
360
|
}
|
|
@@ -425,7 +433,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
425
433
|
var localVarAxiosParamCreator = (0, exports.BankTransactionApiAxiosParamCreator)(configuration);
|
|
426
434
|
return {
|
|
427
435
|
/**
|
|
428
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
436
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
429
437
|
* @summary Invoice Match Suggestion
|
|
430
438
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
431
439
|
* @param {string} [authorization] Bearer Token
|
|
@@ -450,7 +458,7 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
450
458
|
* @summary Retrieve the bank transaction
|
|
451
459
|
* @param {string} code
|
|
452
460
|
* @param {string} [authorization] Bearer Token
|
|
453
|
-
* @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>
|
|
461
|
+
* @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>
|
|
454
462
|
* @param {*} [options] Override http request option.
|
|
455
463
|
* @throws {RequiredError}
|
|
456
464
|
*/
|
|
@@ -468,9 +476,9 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
468
476
|
});
|
|
469
477
|
},
|
|
470
478
|
/**
|
|
471
|
-
* This will import bank transactions from a
|
|
479
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
472
480
|
* @summary Create the bank transactions
|
|
473
|
-
* @param {any} file
|
|
481
|
+
* @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
|
|
474
482
|
* @param {string} [authorization] Bearer Token
|
|
475
483
|
* @param {*} [options] Override http request option.
|
|
476
484
|
* @throws {RequiredError}
|
|
@@ -514,20 +522,22 @@ var BankTransactionApiFp = function (configuration) {
|
|
|
514
522
|
* 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\"
|
|
515
523
|
* @summary List bank transactions
|
|
516
524
|
* @param {string} [authorization] Bearer Token
|
|
517
|
-
* @param {
|
|
518
|
-
* @param {string} [
|
|
525
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
526
|
+
* @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.
|
|
527
|
+
* @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>
|
|
519
528
|
* @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>
|
|
520
|
-
* @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,
|
|
521
|
-
* @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>
|
|
529
|
+
* @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>
|
|
530
|
+
* @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>
|
|
531
|
+
* @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>
|
|
522
532
|
* @param {*} [options] Override http request option.
|
|
523
533
|
* @throws {RequiredError}
|
|
524
534
|
*/
|
|
525
|
-
listBankTransactions: function (authorization,
|
|
535
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
526
536
|
return __awaiter(this, void 0, void 0, function () {
|
|
527
537
|
var localVarAxiosArgs;
|
|
528
538
|
return __generator(this, function (_a) {
|
|
529
539
|
switch (_a.label) {
|
|
530
|
-
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization,
|
|
540
|
+
case 0: return [4 /*yield*/, localVarAxiosParamCreator.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
|
|
531
541
|
case 1:
|
|
532
542
|
localVarAxiosArgs = _a.sent();
|
|
533
543
|
return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
|
|
@@ -568,7 +578,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
568
578
|
var localVarFp = (0, exports.BankTransactionApiFp)(configuration);
|
|
569
579
|
return {
|
|
570
580
|
/**
|
|
571
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
581
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
572
582
|
* @summary Invoice Match Suggestion
|
|
573
583
|
* @param {string} code Code of the bank transaction to generate match suggestions for
|
|
574
584
|
* @param {string} [authorization] Bearer Token
|
|
@@ -583,7 +593,7 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
583
593
|
* @summary Retrieve the bank transaction
|
|
584
594
|
* @param {string} code
|
|
585
595
|
* @param {string} [authorization] Bearer Token
|
|
586
|
-
* @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>
|
|
596
|
+
* @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>
|
|
587
597
|
* @param {*} [options] Override http request option.
|
|
588
598
|
* @throws {RequiredError}
|
|
589
599
|
*/
|
|
@@ -591,9 +601,9 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
591
601
|
return localVarFp.getBankTransaction(code, authorization, expand, options).then(function (request) { return request(axios, basePath); });
|
|
592
602
|
},
|
|
593
603
|
/**
|
|
594
|
-
* This will import bank transactions from a
|
|
604
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
595
605
|
* @summary Create the bank transactions
|
|
596
|
-
* @param {any} file
|
|
606
|
+
* @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
|
|
597
607
|
* @param {string} [authorization] Bearer Token
|
|
598
608
|
* @param {*} [options] Override http request option.
|
|
599
609
|
* @throws {RequiredError}
|
|
@@ -617,16 +627,18 @@ var BankTransactionApiFactory = function (configuration, basePath, axios) {
|
|
|
617
627
|
* 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\"
|
|
618
628
|
* @summary List bank transactions
|
|
619
629
|
* @param {string} [authorization] Bearer Token
|
|
620
|
-
* @param {
|
|
621
|
-
* @param {string} [
|
|
630
|
+
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
|
|
631
|
+
* @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.
|
|
632
|
+
* @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>
|
|
622
633
|
* @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>
|
|
623
|
-
* @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,
|
|
624
|
-
* @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>
|
|
634
|
+
* @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>
|
|
635
|
+
* @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>
|
|
636
|
+
* @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>
|
|
625
637
|
* @param {*} [options] Override http request option.
|
|
626
638
|
* @throws {RequiredError}
|
|
627
639
|
*/
|
|
628
|
-
listBankTransactions: function (authorization,
|
|
629
|
-
return localVarFp.listBankTransactions(authorization,
|
|
640
|
+
listBankTransactions: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
|
|
641
|
+
return localVarFp.listBankTransactions(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
|
|
630
642
|
},
|
|
631
643
|
/**
|
|
632
644
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|
|
@@ -655,7 +667,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
655
667
|
return _super !== null && _super.apply(this, arguments) || this;
|
|
656
668
|
}
|
|
657
669
|
/**
|
|
658
|
-
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.
|
|
670
|
+
* Generate suggestion for matching a bank transaction with an Invoice **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
659
671
|
* @summary Invoice Match Suggestion
|
|
660
672
|
* @param {BankTransactionApiGenerateInvoiceMatchSuggestionRequest} requestParameters Request parameters.
|
|
661
673
|
* @param {*} [options] Override http request option.
|
|
@@ -679,7 +691,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
679
691
|
return (0, exports.BankTransactionApiFp)(this.configuration).getBankTransaction(requestParameters.code, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
|
|
680
692
|
};
|
|
681
693
|
/**
|
|
682
|
-
* This will import bank transactions from a
|
|
694
|
+
* This will import bank transactions from a MT940/CAMT.053 file **Required Permissions** \"payment-management.bank-accounts.view\"
|
|
683
695
|
* @summary Create the bank transactions
|
|
684
696
|
* @param {BankTransactionApiImportBankTransactionsRequest} requestParameters Request parameters.
|
|
685
697
|
* @param {*} [options] Override http request option.
|
|
@@ -713,7 +725,7 @@ var BankTransactionApi = /** @class */ (function (_super) {
|
|
|
713
725
|
BankTransactionApi.prototype.listBankTransactions = function (requestParameters, options) {
|
|
714
726
|
var _this = this;
|
|
715
727
|
if (requestParameters === void 0) { requestParameters = {}; }
|
|
716
|
-
return (0, exports.BankTransactionApiFp)(this.configuration).listBankTransactions(requestParameters.authorization, requestParameters.
|
|
728
|
+
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); });
|
|
717
729
|
};
|
|
718
730
|
/**
|
|
719
731
|
* Unlinks an already linked bank transaction **Required Permissions** \"payment-management.bank-accounts.update\"
|