@emilgroup/accounting-sdk-node 1.32.1-beta.3 → 1.32.1-beta.30

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.
Files changed (122) hide show
  1. package/.openapi-generator/FILES +30 -0
  2. package/README.md +2 -2
  3. package/api/accounting-configs-api.ts +97 -7
  4. package/api/booking-entries-api.ts +107 -0
  5. package/api/commission-account-mappings-api.ts +1195 -0
  6. package/api/financial-accounts-api.ts +132 -12
  7. package/api/product-account-mappings-api.ts +1474 -0
  8. package/api.ts +4 -0
  9. package/dist/api/accounting-configs-api.d.ts +47 -0
  10. package/dist/api/accounting-configs-api.js +94 -7
  11. package/dist/api/booking-entries-api.d.ts +57 -0
  12. package/dist/api/booking-entries-api.js +93 -0
  13. package/dist/api/commission-account-mappings-api.d.ts +685 -0
  14. package/dist/api/commission-account-mappings-api.js +1008 -0
  15. package/dist/api/financial-accounts-api.d.ts +78 -12
  16. package/dist/api/financial-accounts-api.js +109 -10
  17. package/dist/api/product-account-mappings-api.d.ts +851 -0
  18. package/dist/api/product-account-mappings-api.js +1228 -0
  19. package/dist/api.d.ts +2 -0
  20. package/dist/api.js +2 -0
  21. package/dist/models/accounting-config-class.d.ts +11 -0
  22. package/dist/models/accounting-config-class.js +5 -0
  23. package/dist/models/booking-entry-class.d.ts +19 -0
  24. package/dist/models/booking-entry-class.js +7 -1
  25. package/dist/models/commission-account-mapping-class.d.ts +49 -0
  26. package/dist/models/commission-account-mapping-class.js +15 -0
  27. package/dist/models/commission-agreement-account-mapping-detail-class.d.ts +44 -0
  28. package/dist/models/commission-agreement-account-mapping-detail-class.js +15 -0
  29. package/dist/models/commission-agreement-partner-class.d.ts +30 -0
  30. package/dist/models/commission-agreement-partner-class.js +15 -0
  31. package/dist/models/commission-agreement-with-account-mapping-class.d.ts +43 -0
  32. package/dist/models/commission-agreement-with-account-mapping-class.js +15 -0
  33. package/dist/models/commission-type-account-mapping-class.d.ts +31 -0
  34. package/dist/models/commission-type-account-mapping-class.js +15 -0
  35. package/dist/models/create-booking-entry-request-dto.d.ts +19 -0
  36. package/dist/models/create-booking-entry-request-dto.js +7 -0
  37. package/dist/models/create-financial-account-request-dto.d.ts +12 -0
  38. package/dist/models/financial-account-class.d.ts +30 -1
  39. package/dist/models/financial-account-class.js +5 -1
  40. package/dist/models/get-activation-snapshot-response-class.d.ts +25 -0
  41. package/dist/models/get-activation-snapshot-response-class.js +15 -0
  42. package/dist/models/index.d.ts +28 -0
  43. package/dist/models/index.js +28 -0
  44. package/dist/models/list-commission-account-mappings-response-class.d.ts +43 -0
  45. package/dist/models/list-commission-account-mappings-response-class.js +15 -0
  46. package/dist/models/list-commission-agreements-with-account-mappings-response-class.d.ts +43 -0
  47. package/dist/models/list-commission-agreements-with-account-mappings-response-class.js +15 -0
  48. package/dist/models/list-commission-type-account-mappings-response-class.d.ts +43 -0
  49. package/dist/models/list-commission-type-account-mappings-response-class.js +15 -0
  50. package/dist/models/list-product-account-mappings-response-class.d.ts +43 -0
  51. package/dist/models/list-product-account-mappings-response-class.js +15 -0
  52. package/dist/models/list-products-with-account-mappings-response-class.d.ts +43 -0
  53. package/dist/models/list-products-with-account-mappings-response-class.js +15 -0
  54. package/dist/models/post-financial-event-request-dto.d.ts +43 -0
  55. package/dist/models/post-financial-event-request-dto.js +22 -0
  56. package/dist/models/post-financial-event-response-class.d.ts +25 -0
  57. package/dist/models/post-financial-event-response-class.js +15 -0
  58. package/dist/models/premium-item-account-mapping-class.d.ts +37 -0
  59. package/dist/models/premium-item-account-mapping-class.js +15 -0
  60. package/dist/models/product-account-mapping-class.d.ts +61 -0
  61. package/dist/models/product-account-mapping-class.js +15 -0
  62. package/dist/models/product-account-mapping-detail-class.d.ts +50 -0
  63. package/dist/models/product-account-mapping-detail-class.js +15 -0
  64. package/dist/models/product-version-account-mapping-detail-class.d.ts +50 -0
  65. package/dist/models/product-version-account-mapping-detail-class.js +15 -0
  66. package/dist/models/product-version-with-account-mappings-class.d.ts +42 -0
  67. package/dist/models/product-version-with-account-mappings-class.js +15 -0
  68. package/dist/models/product-with-account-mappings-class.d.ts +49 -0
  69. package/dist/models/product-with-account-mappings-class.js +15 -0
  70. package/dist/models/put-premium-item-account-body-dto.d.ts +24 -0
  71. package/dist/models/put-premium-item-account-body-dto.js +15 -0
  72. package/dist/models/put-product-category-account-body-dto.d.ts +24 -0
  73. package/dist/models/put-product-category-account-body-dto.js +15 -0
  74. package/dist/models/put-product-version-category-account-body-dto.d.ts +24 -0
  75. package/dist/models/put-product-version-category-account-body-dto.js +15 -0
  76. package/dist/models/resolved-account-mapping-class.d.ts +31 -0
  77. package/dist/models/resolved-account-mapping-class.js +15 -0
  78. package/dist/models/resolved-commission-account-mapping-class.d.ts +37 -0
  79. package/dist/models/resolved-commission-account-mapping-class.js +21 -0
  80. package/dist/models/update-commission-agreement-account-body-dto.d.ts +24 -0
  81. package/dist/models/update-commission-agreement-account-body-dto.js +15 -0
  82. package/dist/models/update-commission-type-account-body-dto.d.ts +24 -0
  83. package/dist/models/update-commission-type-account-body-dto.js +15 -0
  84. package/dist/models/update-financial-account-body-dto.d.ts +48 -0
  85. package/dist/models/update-financial-account-body-dto.js +15 -0
  86. package/dist/models/update-financial-account-response-class.d.ts +25 -0
  87. package/dist/models/update-financial-account-response-class.js +15 -0
  88. package/models/accounting-config-class.ts +14 -0
  89. package/models/booking-entry-class.ts +20 -0
  90. package/models/commission-account-mapping-class.ts +55 -0
  91. package/models/commission-agreement-account-mapping-detail-class.ts +50 -0
  92. package/models/commission-agreement-partner-class.ts +36 -0
  93. package/models/commission-agreement-with-account-mapping-class.ts +49 -0
  94. package/models/commission-type-account-mapping-class.ts +37 -0
  95. package/models/create-booking-entry-request-dto.ts +22 -0
  96. package/models/create-financial-account-request-dto.ts +12 -0
  97. package/models/financial-account-class.ts +31 -1
  98. package/models/get-activation-snapshot-response-class.ts +31 -0
  99. package/models/index.ts +28 -0
  100. package/models/list-commission-account-mappings-response-class.ts +49 -0
  101. package/models/list-commission-agreements-with-account-mappings-response-class.ts +49 -0
  102. package/models/list-commission-type-account-mappings-response-class.ts +49 -0
  103. package/models/list-product-account-mappings-response-class.ts +49 -0
  104. package/models/list-products-with-account-mappings-response-class.ts +49 -0
  105. package/models/post-financial-event-request-dto.ts +52 -0
  106. package/models/post-financial-event-response-class.ts +31 -0
  107. package/models/premium-item-account-mapping-class.ts +43 -0
  108. package/models/product-account-mapping-class.ts +67 -0
  109. package/models/product-account-mapping-detail-class.ts +56 -0
  110. package/models/product-version-account-mapping-detail-class.ts +56 -0
  111. package/models/product-version-with-account-mappings-class.ts +48 -0
  112. package/models/product-with-account-mappings-class.ts +55 -0
  113. package/models/put-premium-item-account-body-dto.ts +30 -0
  114. package/models/put-product-category-account-body-dto.ts +30 -0
  115. package/models/put-product-version-category-account-body-dto.ts +30 -0
  116. package/models/resolved-account-mapping-class.ts +37 -0
  117. package/models/resolved-commission-account-mapping-class.ts +46 -0
  118. package/models/update-commission-agreement-account-body-dto.ts +30 -0
  119. package/models/update-commission-type-account-body-dto.ts +30 -0
  120. package/models/update-financial-account-body-dto.ts +54 -0
  121. package/models/update-financial-account-response-class.ts +31 -0
  122. package/package.json +1 -1
@@ -0,0 +1,1195 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL AccountingService
5
+ * The EMIL AccountingService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import globalAxios, { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
17
+ import { Configuration } from '../configuration';
18
+ // Some imports not used depending on template conditions
19
+ // @ts-ignore
20
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
21
+ // @ts-ignore
22
+ import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from '../base';
23
+ // @ts-ignore
24
+ import { CommissionAgreementAccountMappingDetailClass } from '../models';
25
+ // @ts-ignore
26
+ import { ListCommissionAccountMappingsResponseClass } from '../models';
27
+ // @ts-ignore
28
+ import { ListCommissionAgreementsWithAccountMappingsResponseClass } from '../models';
29
+ // @ts-ignore
30
+ import { ListCommissionTypeAccountMappingsResponseClass } from '../models';
31
+ // @ts-ignore
32
+ import { ResolvedCommissionAccountMappingClass } from '../models';
33
+ // @ts-ignore
34
+ import { UpdateCommissionAgreementAccountBodyDto } from '../models';
35
+ // @ts-ignore
36
+ import { UpdateCommissionTypeAccountBodyDto } from '../models';
37
+ // URLSearchParams not necessarily used
38
+ // @ts-ignore
39
+ import { URL, URLSearchParams } from 'url';
40
+ const FormData = require('form-data');
41
+ /**
42
+ * CommissionAccountMappingsApi - axios parameter creator
43
+ * @export
44
+ */
45
+ export const CommissionAccountMappingsApiAxiosParamCreator = function (configuration?: Configuration) {
46
+ return {
47
+ /**
48
+ * Permanently deletes the Commission Agreement Account. Supply the unique code that was returned when you created the Commission Agreement Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
49
+ * @summary Delete the Commission Agreement Account
50
+ * @param {string} commissionAgreementCode
51
+ * @param {string} commissionType
52
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
53
+ * @param {*} [options] Override http request option.
54
+ * @throws {RequiredError}
55
+ */
56
+ deleteCommissionAgreementAccount: async (commissionAgreementCode: string, commissionType: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
57
+ // verify required parameter 'commissionAgreementCode' is not null or undefined
58
+ assertParamExists('deleteCommissionAgreementAccount', 'commissionAgreementCode', commissionAgreementCode)
59
+ // verify required parameter 'commissionType' is not null or undefined
60
+ assertParamExists('deleteCommissionAgreementAccount', 'commissionType', commissionType)
61
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/agreements/{commissionAgreementCode}/commission-type/{commissionType}`
62
+ .replace(`{${"commissionAgreementCode"}}`, encodeURIComponent(String(commissionAgreementCode)))
63
+ .replace(`{${"commissionType"}}`, encodeURIComponent(String(commissionType)));
64
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
65
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
66
+ let baseOptions;
67
+ let baseAccessToken;
68
+ if (configuration) {
69
+ baseOptions = configuration.baseOptions;
70
+ baseAccessToken = configuration.accessToken;
71
+ }
72
+
73
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
74
+ const localVarHeaderParameter = {} as any;
75
+ const localVarQueryParameter = {} as any;
76
+
77
+ // authentication bearer required
78
+ // http bearer authentication required
79
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
80
+
81
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
82
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
83
+ }
84
+
85
+
86
+
87
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
88
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
89
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
90
+
91
+ return {
92
+ url: toPathString(localVarUrlObj),
93
+ options: localVarRequestOptions,
94
+ };
95
+ },
96
+ /**
97
+ * Permanently deletes the Commission Type Account. Supply the unique code that was returned when you created the Commission Type Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
98
+ * @summary Delete the Commission Type Account
99
+ * @param {string} commissionType
100
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
101
+ * @param {*} [options] Override http request option.
102
+ * @throws {RequiredError}
103
+ */
104
+ deleteCommissionTypeAccount: async (commissionType: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
105
+ // verify required parameter 'commissionType' is not null or undefined
106
+ assertParamExists('deleteCommissionTypeAccount', 'commissionType', commissionType)
107
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/types/{commissionType}`
108
+ .replace(`{${"commissionType"}}`, encodeURIComponent(String(commissionType)));
109
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
110
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
111
+ let baseOptions;
112
+ let baseAccessToken;
113
+ if (configuration) {
114
+ baseOptions = configuration.baseOptions;
115
+ baseAccessToken = configuration.accessToken;
116
+ }
117
+
118
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
119
+ const localVarHeaderParameter = {} as any;
120
+ const localVarQueryParameter = {} as any;
121
+
122
+ // authentication bearer required
123
+ // http bearer authentication required
124
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
125
+
126
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
127
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
128
+ }
129
+
130
+
131
+
132
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
133
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
134
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
135
+
136
+ return {
137
+ url: toPathString(localVarUrlObj),
138
+ options: localVarRequestOptions,
139
+ };
140
+ },
141
+ /**
142
+ * Retrieves the details of the Commission Agreement Account Mapping that was previously created. Supply the unique Commission Agreement Account Mapping code that was returned when you created it and Emil Api will return the corresponding Commission Agreement Account Mapping information. **Required Permissions** \"accounting-management.financial-accounts.view\"
143
+ * @summary Retrieve the Commission Agreement Account Mapping
144
+ * @param {string} commissionAgreementCode
145
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
146
+ * @param {*} [options] Override http request option.
147
+ * @throws {RequiredError}
148
+ */
149
+ getCommissionAgreementAccountMapping: async (commissionAgreementCode: string, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
150
+ // verify required parameter 'commissionAgreementCode' is not null or undefined
151
+ assertParamExists('getCommissionAgreementAccountMapping', 'commissionAgreementCode', commissionAgreementCode)
152
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/agreements/{commissionAgreementCode}`
153
+ .replace(`{${"commissionAgreementCode"}}`, encodeURIComponent(String(commissionAgreementCode)));
154
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
155
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
156
+ let baseOptions;
157
+ let baseAccessToken;
158
+ if (configuration) {
159
+ baseOptions = configuration.baseOptions;
160
+ baseAccessToken = configuration.accessToken;
161
+ }
162
+
163
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
164
+ const localVarHeaderParameter = {} as any;
165
+ const localVarQueryParameter = {} as any;
166
+
167
+ // authentication bearer required
168
+ // http bearer authentication required
169
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
170
+
171
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
172
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
173
+ }
174
+
175
+
176
+
177
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
178
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
179
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
180
+
181
+ return {
182
+ url: toPathString(localVarUrlObj),
183
+ options: localVarRequestOptions,
184
+ };
185
+ },
186
+ /**
187
+ * Paginated list of the actual stored override rows, across both levels (commission type/agreement). Filterable by commissionAgreementCode/commissionType. For browsing the commission-type standards or the agreement catalog, use the more specific endpoints below instead. **Required Permissions** \"accounting-management.financial-accounts.view\"
188
+ * @summary List Commission Account Mappings
189
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
190
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
191
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
192
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
193
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
194
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
195
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
196
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
197
+ * @param {*} [options] Override http request option.
198
+ * @throws {RequiredError}
199
+ */
200
+ listCommissionAccountMappings: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
201
+ const localVarPath = `/accountingservice/v1/commission-account-mappings`;
202
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
203
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
204
+ let baseOptions;
205
+ let baseAccessToken;
206
+ if (configuration) {
207
+ baseOptions = configuration.baseOptions;
208
+ baseAccessToken = configuration.accessToken;
209
+ }
210
+
211
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
212
+ const localVarHeaderParameter = {} as any;
213
+ const localVarQueryParameter = {} as any;
214
+
215
+ // authentication bearer required
216
+ // http bearer authentication required
217
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
218
+
219
+ if (pageSize !== undefined) {
220
+ localVarQueryParameter['pageSize'] = pageSize;
221
+ }
222
+
223
+ if (pageToken !== undefined) {
224
+ localVarQueryParameter['pageToken'] = pageToken;
225
+ }
226
+
227
+ if (filter !== undefined) {
228
+ localVarQueryParameter['filter'] = filter;
229
+ }
230
+
231
+ if (search !== undefined) {
232
+ localVarQueryParameter['search'] = search;
233
+ }
234
+
235
+ if (order !== undefined) {
236
+ localVarQueryParameter['order'] = order;
237
+ }
238
+
239
+ if (expand !== undefined) {
240
+ localVarQueryParameter['expand'] = expand;
241
+ }
242
+
243
+ if (filters !== undefined) {
244
+ localVarQueryParameter['filters'] = filters;
245
+ }
246
+
247
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
248
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
249
+ }
250
+
251
+
252
+
253
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
254
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
255
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
256
+
257
+ return {
258
+ url: toPathString(localVarUrlObj),
259
+ options: localVarRequestOptions,
260
+ };
261
+ },
262
+ /**
263
+ * Paginated commission-agreement catalog (proxied from commissionservice), each item carrying its Agreement Number, Main Partner, and a hasCustomMapping badge. Cheap -- no per-type resolution, badges only. **Required Permissions** \"accounting-management.financial-accounts.view\"
264
+ * @summary List Commission Agreements With Account Mappings
265
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
266
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
267
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
268
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
269
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
270
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
271
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
272
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
273
+ * @param {*} [options] Override http request option.
274
+ * @throws {RequiredError}
275
+ */
276
+ listCommissionAgreementsWithAccountMappings: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
277
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/agreements`;
278
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
279
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
280
+ let baseOptions;
281
+ let baseAccessToken;
282
+ if (configuration) {
283
+ baseOptions = configuration.baseOptions;
284
+ baseAccessToken = configuration.accessToken;
285
+ }
286
+
287
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
288
+ const localVarHeaderParameter = {} as any;
289
+ const localVarQueryParameter = {} as any;
290
+
291
+ // authentication bearer required
292
+ // http bearer authentication required
293
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
294
+
295
+ if (pageSize !== undefined) {
296
+ localVarQueryParameter['pageSize'] = pageSize;
297
+ }
298
+
299
+ if (pageToken !== undefined) {
300
+ localVarQueryParameter['pageToken'] = pageToken;
301
+ }
302
+
303
+ if (filter !== undefined) {
304
+ localVarQueryParameter['filter'] = filter;
305
+ }
306
+
307
+ if (search !== undefined) {
308
+ localVarQueryParameter['search'] = search;
309
+ }
310
+
311
+ if (order !== undefined) {
312
+ localVarQueryParameter['order'] = order;
313
+ }
314
+
315
+ if (expand !== undefined) {
316
+ localVarQueryParameter['expand'] = expand;
317
+ }
318
+
319
+ if (filters !== undefined) {
320
+ localVarQueryParameter['filters'] = filters;
321
+ }
322
+
323
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
324
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
325
+ }
326
+
327
+
328
+
329
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
330
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
331
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
332
+
333
+ return {
334
+ url: toPathString(localVarUrlObj),
335
+ options: localVarRequestOptions,
336
+ };
337
+ },
338
+ /**
339
+ * Paginated \"Standards per Commission Type\" section -- one entry per commission type that currently has a tenant-wide default. **Required Permissions** \"accounting-management.financial-accounts.view\"
340
+ * @summary List Commission Type Standards
341
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
342
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
343
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
344
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
345
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
346
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
347
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
348
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
349
+ * @param {*} [options] Override http request option.
350
+ * @throws {RequiredError}
351
+ */
352
+ listCommissionTypeAccountMappings: async (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
353
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/types`;
354
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
355
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
356
+ let baseOptions;
357
+ let baseAccessToken;
358
+ if (configuration) {
359
+ baseOptions = configuration.baseOptions;
360
+ baseAccessToken = configuration.accessToken;
361
+ }
362
+
363
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
364
+ const localVarHeaderParameter = {} as any;
365
+ const localVarQueryParameter = {} as any;
366
+
367
+ // authentication bearer required
368
+ // http bearer authentication required
369
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
370
+
371
+ if (pageSize !== undefined) {
372
+ localVarQueryParameter['pageSize'] = pageSize;
373
+ }
374
+
375
+ if (pageToken !== undefined) {
376
+ localVarQueryParameter['pageToken'] = pageToken;
377
+ }
378
+
379
+ if (filter !== undefined) {
380
+ localVarQueryParameter['filter'] = filter;
381
+ }
382
+
383
+ if (search !== undefined) {
384
+ localVarQueryParameter['search'] = search;
385
+ }
386
+
387
+ if (order !== undefined) {
388
+ localVarQueryParameter['order'] = order;
389
+ }
390
+
391
+ if (expand !== undefined) {
392
+ localVarQueryParameter['expand'] = expand;
393
+ }
394
+
395
+ if (filters !== undefined) {
396
+ localVarQueryParameter['filters'] = filters;
397
+ }
398
+
399
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
400
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
401
+ }
402
+
403
+
404
+
405
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
406
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
407
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
408
+
409
+ return {
410
+ url: toPathString(localVarUrlObj),
411
+ options: localVarRequestOptions,
412
+ };
413
+ },
414
+ /**
415
+ * Updates the specified Commission Agreement Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
416
+ * @summary Update the Commission Agreement Account
417
+ * @param {string} commissionAgreementCode
418
+ * @param {string} commissionType
419
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
420
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
421
+ * @param {*} [options] Override http request option.
422
+ * @throws {RequiredError}
423
+ */
424
+ updateCommissionAgreementAccount: async (commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
425
+ // verify required parameter 'commissionAgreementCode' is not null or undefined
426
+ assertParamExists('updateCommissionAgreementAccount', 'commissionAgreementCode', commissionAgreementCode)
427
+ // verify required parameter 'commissionType' is not null or undefined
428
+ assertParamExists('updateCommissionAgreementAccount', 'commissionType', commissionType)
429
+ // verify required parameter 'updateCommissionAgreementAccountBodyDto' is not null or undefined
430
+ assertParamExists('updateCommissionAgreementAccount', 'updateCommissionAgreementAccountBodyDto', updateCommissionAgreementAccountBodyDto)
431
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/agreements/{commissionAgreementCode}/commission-type/{commissionType}`
432
+ .replace(`{${"commissionAgreementCode"}}`, encodeURIComponent(String(commissionAgreementCode)))
433
+ .replace(`{${"commissionType"}}`, encodeURIComponent(String(commissionType)));
434
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
435
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
436
+ let baseOptions;
437
+ let baseAccessToken;
438
+ if (configuration) {
439
+ baseOptions = configuration.baseOptions;
440
+ baseAccessToken = configuration.accessToken;
441
+ }
442
+
443
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
444
+ const localVarHeaderParameter = {} as any;
445
+ const localVarQueryParameter = {} as any;
446
+
447
+ // authentication bearer required
448
+ // http bearer authentication required
449
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
450
+
451
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
452
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
453
+ }
454
+
455
+
456
+
457
+ localVarHeaderParameter['Content-Type'] = 'application/json';
458
+
459
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
460
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
461
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
462
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCommissionAgreementAccountBodyDto, localVarRequestOptions, configuration)
463
+
464
+ return {
465
+ url: toPathString(localVarUrlObj),
466
+ options: localVarRequestOptions,
467
+ };
468
+ },
469
+ /**
470
+ * Updates the specified Commission Type Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
471
+ * @summary Update the Commission Type Account
472
+ * @param {string} commissionType
473
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
474
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
475
+ * @param {*} [options] Override http request option.
476
+ * @throws {RequiredError}
477
+ */
478
+ updateCommissionTypeAccount: async (commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
479
+ // verify required parameter 'commissionType' is not null or undefined
480
+ assertParamExists('updateCommissionTypeAccount', 'commissionType', commissionType)
481
+ // verify required parameter 'updateCommissionTypeAccountBodyDto' is not null or undefined
482
+ assertParamExists('updateCommissionTypeAccount', 'updateCommissionTypeAccountBodyDto', updateCommissionTypeAccountBodyDto)
483
+ const localVarPath = `/accountingservice/v1/commission-account-mappings/types/{commissionType}`
484
+ .replace(`{${"commissionType"}}`, encodeURIComponent(String(commissionType)));
485
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
486
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
487
+ let baseOptions;
488
+ let baseAccessToken;
489
+ if (configuration) {
490
+ baseOptions = configuration.baseOptions;
491
+ baseAccessToken = configuration.accessToken;
492
+ }
493
+
494
+ const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
495
+ const localVarHeaderParameter = {} as any;
496
+ const localVarQueryParameter = {} as any;
497
+
498
+ // authentication bearer required
499
+ // http bearer authentication required
500
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
501
+
502
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
503
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
504
+ }
505
+
506
+
507
+
508
+ localVarHeaderParameter['Content-Type'] = 'application/json';
509
+
510
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
511
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
512
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
513
+ localVarRequestOptions.data = serializeDataIfNeeded(updateCommissionTypeAccountBodyDto, localVarRequestOptions, configuration)
514
+
515
+ return {
516
+ url: toPathString(localVarUrlObj),
517
+ options: localVarRequestOptions,
518
+ };
519
+ },
520
+ }
521
+ };
522
+
523
+ /**
524
+ * CommissionAccountMappingsApi - functional programming interface
525
+ * @export
526
+ */
527
+ export const CommissionAccountMappingsApiFp = function(configuration?: Configuration) {
528
+ const localVarAxiosParamCreator = CommissionAccountMappingsApiAxiosParamCreator(configuration)
529
+ return {
530
+ /**
531
+ * Permanently deletes the Commission Agreement Account. Supply the unique code that was returned when you created the Commission Agreement Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
532
+ * @summary Delete the Commission Agreement Account
533
+ * @param {string} commissionAgreementCode
534
+ * @param {string} commissionType
535
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
536
+ * @param {*} [options] Override http request option.
537
+ * @throws {RequiredError}
538
+ */
539
+ async deleteCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
540
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommissionAgreementAccount(commissionAgreementCode, commissionType, authorization, options);
541
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
542
+ },
543
+ /**
544
+ * Permanently deletes the Commission Type Account. Supply the unique code that was returned when you created the Commission Type Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
545
+ * @summary Delete the Commission Type Account
546
+ * @param {string} commissionType
547
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
548
+ * @param {*} [options] Override http request option.
549
+ * @throws {RequiredError}
550
+ */
551
+ async deleteCommissionTypeAccount(commissionType: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
552
+ const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCommissionTypeAccount(commissionType, authorization, options);
553
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
554
+ },
555
+ /**
556
+ * Retrieves the details of the Commission Agreement Account Mapping that was previously created. Supply the unique Commission Agreement Account Mapping code that was returned when you created it and Emil Api will return the corresponding Commission Agreement Account Mapping information. **Required Permissions** \"accounting-management.financial-accounts.view\"
557
+ * @summary Retrieve the Commission Agreement Account Mapping
558
+ * @param {string} commissionAgreementCode
559
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
560
+ * @param {*} [options] Override http request option.
561
+ * @throws {RequiredError}
562
+ */
563
+ async getCommissionAgreementAccountMapping(commissionAgreementCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommissionAgreementAccountMappingDetailClass>> {
564
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getCommissionAgreementAccountMapping(commissionAgreementCode, authorization, options);
565
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
566
+ },
567
+ /**
568
+ * Paginated list of the actual stored override rows, across both levels (commission type/agreement). Filterable by commissionAgreementCode/commissionType. For browsing the commission-type standards or the agreement catalog, use the more specific endpoints below instead. **Required Permissions** \"accounting-management.financial-accounts.view\"
569
+ * @summary List Commission Account Mappings
570
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
571
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
572
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
573
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
574
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
575
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
576
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
577
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
578
+ * @param {*} [options] Override http request option.
579
+ * @throws {RequiredError}
580
+ */
581
+ async listCommissionAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAccountMappingsResponseClass>> {
582
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
583
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
584
+ },
585
+ /**
586
+ * Paginated commission-agreement catalog (proxied from commissionservice), each item carrying its Agreement Number, Main Partner, and a hasCustomMapping badge. Cheap -- no per-type resolution, badges only. **Required Permissions** \"accounting-management.financial-accounts.view\"
587
+ * @summary List Commission Agreements With Account Mappings
588
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
589
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
590
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
591
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
592
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
593
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
594
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
595
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
596
+ * @param {*} [options] Override http request option.
597
+ * @throws {RequiredError}
598
+ */
599
+ async listCommissionAgreementsWithAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionAgreementsWithAccountMappingsResponseClass>> {
600
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionAgreementsWithAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
601
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
602
+ },
603
+ /**
604
+ * Paginated \"Standards per Commission Type\" section -- one entry per commission type that currently has a tenant-wide default. **Required Permissions** \"accounting-management.financial-accounts.view\"
605
+ * @summary List Commission Type Standards
606
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
607
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
608
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
609
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
610
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
611
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
612
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
613
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
614
+ * @param {*} [options] Override http request option.
615
+ * @throws {RequiredError}
616
+ */
617
+ async listCommissionTypeAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionTypeAccountMappingsResponseClass>> {
618
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listCommissionTypeAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options);
619
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
620
+ },
621
+ /**
622
+ * Updates the specified Commission Agreement Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
623
+ * @summary Update the Commission Agreement Account
624
+ * @param {string} commissionAgreementCode
625
+ * @param {string} commissionType
626
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
627
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
628
+ * @param {*} [options] Override http request option.
629
+ * @throws {RequiredError}
630
+ */
631
+ async updateCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResolvedCommissionAccountMappingClass>> {
632
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionAgreementAccount(commissionAgreementCode, commissionType, updateCommissionAgreementAccountBodyDto, authorization, options);
633
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
634
+ },
635
+ /**
636
+ * Updates the specified Commission Type Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
637
+ * @summary Update the Commission Type Account
638
+ * @param {string} commissionType
639
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
640
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
641
+ * @param {*} [options] Override http request option.
642
+ * @throws {RequiredError}
643
+ */
644
+ async updateCommissionTypeAccount(commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResolvedCommissionAccountMappingClass>> {
645
+ const localVarAxiosArgs = await localVarAxiosParamCreator.updateCommissionTypeAccount(commissionType, updateCommissionTypeAccountBodyDto, authorization, options);
646
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
647
+ },
648
+ }
649
+ };
650
+
651
+ /**
652
+ * CommissionAccountMappingsApi - factory interface
653
+ * @export
654
+ */
655
+ export const CommissionAccountMappingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
656
+ const localVarFp = CommissionAccountMappingsApiFp(configuration)
657
+ return {
658
+ /**
659
+ * Permanently deletes the Commission Agreement Account. Supply the unique code that was returned when you created the Commission Agreement Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
660
+ * @summary Delete the Commission Agreement Account
661
+ * @param {string} commissionAgreementCode
662
+ * @param {string} commissionType
663
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
664
+ * @param {*} [options] Override http request option.
665
+ * @throws {RequiredError}
666
+ */
667
+ deleteCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, authorization?: string, options?: any): AxiosPromise<void> {
668
+ return localVarFp.deleteCommissionAgreementAccount(commissionAgreementCode, commissionType, authorization, options).then((request) => request(axios, basePath));
669
+ },
670
+ /**
671
+ * Permanently deletes the Commission Type Account. Supply the unique code that was returned when you created the Commission Type Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
672
+ * @summary Delete the Commission Type Account
673
+ * @param {string} commissionType
674
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
675
+ * @param {*} [options] Override http request option.
676
+ * @throws {RequiredError}
677
+ */
678
+ deleteCommissionTypeAccount(commissionType: string, authorization?: string, options?: any): AxiosPromise<void> {
679
+ return localVarFp.deleteCommissionTypeAccount(commissionType, authorization, options).then((request) => request(axios, basePath));
680
+ },
681
+ /**
682
+ * Retrieves the details of the Commission Agreement Account Mapping that was previously created. Supply the unique Commission Agreement Account Mapping code that was returned when you created it and Emil Api will return the corresponding Commission Agreement Account Mapping information. **Required Permissions** \"accounting-management.financial-accounts.view\"
683
+ * @summary Retrieve the Commission Agreement Account Mapping
684
+ * @param {string} commissionAgreementCode
685
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
686
+ * @param {*} [options] Override http request option.
687
+ * @throws {RequiredError}
688
+ */
689
+ getCommissionAgreementAccountMapping(commissionAgreementCode: string, authorization?: string, options?: any): AxiosPromise<CommissionAgreementAccountMappingDetailClass> {
690
+ return localVarFp.getCommissionAgreementAccountMapping(commissionAgreementCode, authorization, options).then((request) => request(axios, basePath));
691
+ },
692
+ /**
693
+ * Paginated list of the actual stored override rows, across both levels (commission type/agreement). Filterable by commissionAgreementCode/commissionType. For browsing the commission-type standards or the agreement catalog, use the more specific endpoints below instead. **Required Permissions** \"accounting-management.financial-accounts.view\"
694
+ * @summary List Commission Account Mappings
695
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
696
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
697
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
698
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
699
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
700
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
701
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
702
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
703
+ * @param {*} [options] Override http request option.
704
+ * @throws {RequiredError}
705
+ */
706
+ listCommissionAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAccountMappingsResponseClass> {
707
+ return localVarFp.listCommissionAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
708
+ },
709
+ /**
710
+ * Paginated commission-agreement catalog (proxied from commissionservice), each item carrying its Agreement Number, Main Partner, and a hasCustomMapping badge. Cheap -- no per-type resolution, badges only. **Required Permissions** \"accounting-management.financial-accounts.view\"
711
+ * @summary List Commission Agreements With Account Mappings
712
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
713
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
714
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
715
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
716
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
717
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
718
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
719
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
720
+ * @param {*} [options] Override http request option.
721
+ * @throws {RequiredError}
722
+ */
723
+ listCommissionAgreementsWithAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsWithAccountMappingsResponseClass> {
724
+ return localVarFp.listCommissionAgreementsWithAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
725
+ },
726
+ /**
727
+ * Paginated \"Standards per Commission Type\" section -- one entry per commission type that currently has a tenant-wide default. **Required Permissions** \"accounting-management.financial-accounts.view\"
728
+ * @summary List Commission Type Standards
729
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
730
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
731
+ * @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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
732
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
733
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
734
+ * @param {string} [order] The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
735
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
736
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
737
+ * @param {*} [options] Override http request option.
738
+ * @throws {RequiredError}
739
+ */
740
+ listCommissionTypeAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionTypeAccountMappingsResponseClass> {
741
+ return localVarFp.listCommissionTypeAccountMappings(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
742
+ },
743
+ /**
744
+ * Updates the specified Commission Agreement Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
745
+ * @summary Update the Commission Agreement Account
746
+ * @param {string} commissionAgreementCode
747
+ * @param {string} commissionType
748
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
749
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
750
+ * @param {*} [options] Override http request option.
751
+ * @throws {RequiredError}
752
+ */
753
+ updateCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options?: any): AxiosPromise<ResolvedCommissionAccountMappingClass> {
754
+ return localVarFp.updateCommissionAgreementAccount(commissionAgreementCode, commissionType, updateCommissionAgreementAccountBodyDto, authorization, options).then((request) => request(axios, basePath));
755
+ },
756
+ /**
757
+ * Updates the specified Commission Type Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
758
+ * @summary Update the Commission Type Account
759
+ * @param {string} commissionType
760
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
761
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
762
+ * @param {*} [options] Override http request option.
763
+ * @throws {RequiredError}
764
+ */
765
+ updateCommissionTypeAccount(commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options?: any): AxiosPromise<ResolvedCommissionAccountMappingClass> {
766
+ return localVarFp.updateCommissionTypeAccount(commissionType, updateCommissionTypeAccountBodyDto, authorization, options).then((request) => request(axios, basePath));
767
+ },
768
+ };
769
+ };
770
+
771
+ /**
772
+ * Request parameters for deleteCommissionAgreementAccount operation in CommissionAccountMappingsApi.
773
+ * @export
774
+ * @interface CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest
775
+ */
776
+ export interface CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest {
777
+ /**
778
+ *
779
+ * @type {string}
780
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
781
+ */
782
+ readonly commissionAgreementCode: string
783
+
784
+ /**
785
+ *
786
+ * @type {string}
787
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
788
+ */
789
+ readonly commissionType: string
790
+
791
+ /**
792
+ * Bearer Token: provided by the login endpoint under the name accessToken.
793
+ * @type {string}
794
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
795
+ */
796
+ readonly authorization?: string
797
+ }
798
+
799
+ /**
800
+ * Request parameters for deleteCommissionTypeAccount operation in CommissionAccountMappingsApi.
801
+ * @export
802
+ * @interface CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest
803
+ */
804
+ export interface CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest {
805
+ /**
806
+ *
807
+ * @type {string}
808
+ * @memberof CommissionAccountMappingsApiDeleteCommissionTypeAccount
809
+ */
810
+ readonly commissionType: string
811
+
812
+ /**
813
+ * Bearer Token: provided by the login endpoint under the name accessToken.
814
+ * @type {string}
815
+ * @memberof CommissionAccountMappingsApiDeleteCommissionTypeAccount
816
+ */
817
+ readonly authorization?: string
818
+ }
819
+
820
+ /**
821
+ * Request parameters for getCommissionAgreementAccountMapping operation in CommissionAccountMappingsApi.
822
+ * @export
823
+ * @interface CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest
824
+ */
825
+ export interface CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest {
826
+ /**
827
+ *
828
+ * @type {string}
829
+ * @memberof CommissionAccountMappingsApiGetCommissionAgreementAccountMapping
830
+ */
831
+ readonly commissionAgreementCode: string
832
+
833
+ /**
834
+ * Bearer Token: provided by the login endpoint under the name accessToken.
835
+ * @type {string}
836
+ * @memberof CommissionAccountMappingsApiGetCommissionAgreementAccountMapping
837
+ */
838
+ readonly authorization?: string
839
+ }
840
+
841
+ /**
842
+ * Request parameters for listCommissionAccountMappings operation in CommissionAccountMappingsApi.
843
+ * @export
844
+ * @interface CommissionAccountMappingsApiListCommissionAccountMappingsRequest
845
+ */
846
+ export interface CommissionAccountMappingsApiListCommissionAccountMappingsRequest {
847
+ /**
848
+ * Bearer Token: provided by the login endpoint under the name accessToken.
849
+ * @type {string}
850
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
851
+ */
852
+ readonly authorization?: string
853
+
854
+ /**
855
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
856
+ * @type {number}
857
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
858
+ */
859
+ readonly pageSize?: number
860
+
861
+ /**
862
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
863
+ * @type {string}
864
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
865
+ */
866
+ readonly pageToken?: string
867
+
868
+ /**
869
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
870
+ * @type {string}
871
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
872
+ */
873
+ readonly filter?: string
874
+
875
+ /**
876
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
877
+ * @type {string}
878
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
879
+ */
880
+ readonly search?: string
881
+
882
+ /**
883
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
884
+ * @type {string}
885
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
886
+ */
887
+ readonly order?: string
888
+
889
+ /**
890
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
891
+ * @type {string}
892
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
893
+ */
894
+ readonly expand?: string
895
+
896
+ /**
897
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
898
+ * @type {string}
899
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
900
+ */
901
+ readonly filters?: string
902
+ }
903
+
904
+ /**
905
+ * Request parameters for listCommissionAgreementsWithAccountMappings operation in CommissionAccountMappingsApi.
906
+ * @export
907
+ * @interface CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest
908
+ */
909
+ export interface CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest {
910
+ /**
911
+ * Bearer Token: provided by the login endpoint under the name accessToken.
912
+ * @type {string}
913
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
914
+ */
915
+ readonly authorization?: string
916
+
917
+ /**
918
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
919
+ * @type {number}
920
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
921
+ */
922
+ readonly pageSize?: number
923
+
924
+ /**
925
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
926
+ * @type {string}
927
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
928
+ */
929
+ readonly pageToken?: string
930
+
931
+ /**
932
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
933
+ * @type {string}
934
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
935
+ */
936
+ readonly filter?: string
937
+
938
+ /**
939
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
940
+ * @type {string}
941
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
942
+ */
943
+ readonly search?: string
944
+
945
+ /**
946
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
947
+ * @type {string}
948
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
949
+ */
950
+ readonly order?: string
951
+
952
+ /**
953
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
954
+ * @type {string}
955
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
956
+ */
957
+ readonly expand?: string
958
+
959
+ /**
960
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
961
+ * @type {string}
962
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
963
+ */
964
+ readonly filters?: string
965
+ }
966
+
967
+ /**
968
+ * Request parameters for listCommissionTypeAccountMappings operation in CommissionAccountMappingsApi.
969
+ * @export
970
+ * @interface CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest
971
+ */
972
+ export interface CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest {
973
+ /**
974
+ * Bearer Token: provided by the login endpoint under the name accessToken.
975
+ * @type {string}
976
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
977
+ */
978
+ readonly authorization?: string
979
+
980
+ /**
981
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
982
+ * @type {number}
983
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
984
+ */
985
+ readonly pageSize?: number
986
+
987
+ /**
988
+ * 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&#x3D;1, your subsequent call can include pageToken&#x3D;2 in order to fetch the next page of the list.
989
+ * @type {string}
990
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
991
+ */
992
+ readonly pageToken?: string
993
+
994
+ /**
995
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
996
+ * @type {string}
997
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
998
+ */
999
+ readonly filter?: string
1000
+
1001
+ /**
1002
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
1003
+ * @type {string}
1004
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
1005
+ */
1006
+ readonly search?: string
1007
+
1008
+ /**
1009
+ * The order parameter determines how the results should be sorted according to a specified field. It functions similarly to an SQL ORDER BY. Sorting can be performed in either ascending (ASC) or descending (DESC) order. Default: ASC.
1010
+ * @type {string}
1011
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
1012
+ */
1013
+ readonly order?: string
1014
+
1015
+ /**
1016
+ * Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
1017
+ * @type {string}
1018
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
1019
+ */
1020
+ readonly expand?: string
1021
+
1022
+ /**
1023
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations. In general, fetching filtered responses conserves bandwidth and reduces response time.
1024
+ * @type {string}
1025
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
1026
+ */
1027
+ readonly filters?: string
1028
+ }
1029
+
1030
+ /**
1031
+ * Request parameters for updateCommissionAgreementAccount operation in CommissionAccountMappingsApi.
1032
+ * @export
1033
+ * @interface CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest
1034
+ */
1035
+ export interface CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest {
1036
+ /**
1037
+ *
1038
+ * @type {string}
1039
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
1040
+ */
1041
+ readonly commissionAgreementCode: string
1042
+
1043
+ /**
1044
+ *
1045
+ * @type {string}
1046
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
1047
+ */
1048
+ readonly commissionType: string
1049
+
1050
+ /**
1051
+ *
1052
+ * @type {UpdateCommissionAgreementAccountBodyDto}
1053
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
1054
+ */
1055
+ readonly updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto
1056
+
1057
+ /**
1058
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1059
+ * @type {string}
1060
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
1061
+ */
1062
+ readonly authorization?: string
1063
+ }
1064
+
1065
+ /**
1066
+ * Request parameters for updateCommissionTypeAccount operation in CommissionAccountMappingsApi.
1067
+ * @export
1068
+ * @interface CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest
1069
+ */
1070
+ export interface CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest {
1071
+ /**
1072
+ *
1073
+ * @type {string}
1074
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
1075
+ */
1076
+ readonly commissionType: string
1077
+
1078
+ /**
1079
+ *
1080
+ * @type {UpdateCommissionTypeAccountBodyDto}
1081
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
1082
+ */
1083
+ readonly updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto
1084
+
1085
+ /**
1086
+ * Bearer Token: provided by the login endpoint under the name accessToken.
1087
+ * @type {string}
1088
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
1089
+ */
1090
+ readonly authorization?: string
1091
+ }
1092
+
1093
+ /**
1094
+ * CommissionAccountMappingsApi - object-oriented interface
1095
+ * @export
1096
+ * @class CommissionAccountMappingsApi
1097
+ * @extends {BaseAPI}
1098
+ */
1099
+ export class CommissionAccountMappingsApi extends BaseAPI {
1100
+ /**
1101
+ * Permanently deletes the Commission Agreement Account. Supply the unique code that was returned when you created the Commission Agreement Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
1102
+ * @summary Delete the Commission Agreement Account
1103
+ * @param {CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest} requestParameters Request parameters.
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ * @memberof CommissionAccountMappingsApi
1107
+ */
1108
+ public deleteCommissionAgreementAccount(requestParameters: CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest, options?: AxiosRequestConfig) {
1109
+ return CommissionAccountMappingsApiFp(this.configuration).deleteCommissionAgreementAccount(requestParameters.commissionAgreementCode, requestParameters.commissionType, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1110
+ }
1111
+
1112
+ /**
1113
+ * Permanently deletes the Commission Type Account. Supply the unique code that was returned when you created the Commission Type Account and this will delete it. **Required Permissions** \"accounting-management.financial-accounts.delete\"
1114
+ * @summary Delete the Commission Type Account
1115
+ * @param {CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest} requestParameters Request parameters.
1116
+ * @param {*} [options] Override http request option.
1117
+ * @throws {RequiredError}
1118
+ * @memberof CommissionAccountMappingsApi
1119
+ */
1120
+ public deleteCommissionTypeAccount(requestParameters: CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest, options?: AxiosRequestConfig) {
1121
+ return CommissionAccountMappingsApiFp(this.configuration).deleteCommissionTypeAccount(requestParameters.commissionType, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1122
+ }
1123
+
1124
+ /**
1125
+ * Retrieves the details of the Commission Agreement Account Mapping that was previously created. Supply the unique Commission Agreement Account Mapping code that was returned when you created it and Emil Api will return the corresponding Commission Agreement Account Mapping information. **Required Permissions** \"accounting-management.financial-accounts.view\"
1126
+ * @summary Retrieve the Commission Agreement Account Mapping
1127
+ * @param {CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest} requestParameters Request parameters.
1128
+ * @param {*} [options] Override http request option.
1129
+ * @throws {RequiredError}
1130
+ * @memberof CommissionAccountMappingsApi
1131
+ */
1132
+ public getCommissionAgreementAccountMapping(requestParameters: CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest, options?: AxiosRequestConfig) {
1133
+ return CommissionAccountMappingsApiFp(this.configuration).getCommissionAgreementAccountMapping(requestParameters.commissionAgreementCode, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1134
+ }
1135
+
1136
+ /**
1137
+ * Paginated list of the actual stored override rows, across both levels (commission type/agreement). Filterable by commissionAgreementCode/commissionType. For browsing the commission-type standards or the agreement catalog, use the more specific endpoints below instead. **Required Permissions** \"accounting-management.financial-accounts.view\"
1138
+ * @summary List Commission Account Mappings
1139
+ * @param {CommissionAccountMappingsApiListCommissionAccountMappingsRequest} requestParameters Request parameters.
1140
+ * @param {*} [options] Override http request option.
1141
+ * @throws {RequiredError}
1142
+ * @memberof CommissionAccountMappingsApi
1143
+ */
1144
+ public listCommissionAccountMappings(requestParameters: CommissionAccountMappingsApiListCommissionAccountMappingsRequest = {}, options?: AxiosRequestConfig) {
1145
+ return CommissionAccountMappingsApiFp(this.configuration).listCommissionAccountMappings(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1146
+ }
1147
+
1148
+ /**
1149
+ * Paginated commission-agreement catalog (proxied from commissionservice), each item carrying its Agreement Number, Main Partner, and a hasCustomMapping badge. Cheap -- no per-type resolution, badges only. **Required Permissions** \"accounting-management.financial-accounts.view\"
1150
+ * @summary List Commission Agreements With Account Mappings
1151
+ * @param {CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest} requestParameters Request parameters.
1152
+ * @param {*} [options] Override http request option.
1153
+ * @throws {RequiredError}
1154
+ * @memberof CommissionAccountMappingsApi
1155
+ */
1156
+ public listCommissionAgreementsWithAccountMappings(requestParameters: CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest = {}, options?: AxiosRequestConfig) {
1157
+ return CommissionAccountMappingsApiFp(this.configuration).listCommissionAgreementsWithAccountMappings(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1158
+ }
1159
+
1160
+ /**
1161
+ * Paginated \"Standards per Commission Type\" section -- one entry per commission type that currently has a tenant-wide default. **Required Permissions** \"accounting-management.financial-accounts.view\"
1162
+ * @summary List Commission Type Standards
1163
+ * @param {CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest} requestParameters Request parameters.
1164
+ * @param {*} [options] Override http request option.
1165
+ * @throws {RequiredError}
1166
+ * @memberof CommissionAccountMappingsApi
1167
+ */
1168
+ public listCommissionTypeAccountMappings(requestParameters: CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest = {}, options?: AxiosRequestConfig) {
1169
+ return CommissionAccountMappingsApiFp(this.configuration).listCommissionTypeAccountMappings(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then((request) => request(this.axios, this.basePath));
1170
+ }
1171
+
1172
+ /**
1173
+ * Updates the specified Commission Agreement Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
1174
+ * @summary Update the Commission Agreement Account
1175
+ * @param {CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest} requestParameters Request parameters.
1176
+ * @param {*} [options] Override http request option.
1177
+ * @throws {RequiredError}
1178
+ * @memberof CommissionAccountMappingsApi
1179
+ */
1180
+ public updateCommissionAgreementAccount(requestParameters: CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest, options?: AxiosRequestConfig) {
1181
+ return CommissionAccountMappingsApiFp(this.configuration).updateCommissionAgreementAccount(requestParameters.commissionAgreementCode, requestParameters.commissionType, requestParameters.updateCommissionAgreementAccountBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1182
+ }
1183
+
1184
+ /**
1185
+ * Updates the specified Commission Type Account by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"accounting-management.financial-accounts.update\"
1186
+ * @summary Update the Commission Type Account
1187
+ * @param {CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest} requestParameters Request parameters.
1188
+ * @param {*} [options] Override http request option.
1189
+ * @throws {RequiredError}
1190
+ * @memberof CommissionAccountMappingsApi
1191
+ */
1192
+ public updateCommissionTypeAccount(requestParameters: CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest, options?: AxiosRequestConfig) {
1193
+ return CommissionAccountMappingsApiFp(this.configuration).updateCommissionTypeAccount(requestParameters.commissionType, requestParameters.updateCommissionTypeAccountBodyDto, requestParameters.authorization, options).then((request) => request(this.axios, this.basePath));
1194
+ }
1195
+ }