@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,685 @@
1
+ /**
2
+ * EMIL AccountingService
3
+ * The EMIL AccountingService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
+ import { Configuration } from '../configuration';
14
+ import { RequestArgs, BaseAPI } from '../base';
15
+ import { CommissionAgreementAccountMappingDetailClass } from '../models';
16
+ import { ListCommissionAccountMappingsResponseClass } from '../models';
17
+ import { ListCommissionAgreementsWithAccountMappingsResponseClass } from '../models';
18
+ import { ListCommissionTypeAccountMappingsResponseClass } from '../models';
19
+ import { ResolvedCommissionAccountMappingClass } from '../models';
20
+ import { UpdateCommissionAgreementAccountBodyDto } from '../models';
21
+ import { UpdateCommissionTypeAccountBodyDto } from '../models';
22
+ /**
23
+ * CommissionAccountMappingsApi - axios parameter creator
24
+ * @export
25
+ */
26
+ export declare const CommissionAccountMappingsApiAxiosParamCreator: (configuration?: Configuration) => {
27
+ /**
28
+ * 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\"
29
+ * @summary Delete the Commission Agreement Account
30
+ * @param {string} commissionAgreementCode
31
+ * @param {string} commissionType
32
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
33
+ * @param {*} [options] Override http request option.
34
+ * @throws {RequiredError}
35
+ */
36
+ deleteCommissionAgreementAccount: (commissionAgreementCode: string, commissionType: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
37
+ /**
38
+ * 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\"
39
+ * @summary Delete the Commission Type Account
40
+ * @param {string} commissionType
41
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
42
+ * @param {*} [options] Override http request option.
43
+ * @throws {RequiredError}
44
+ */
45
+ deleteCommissionTypeAccount: (commissionType: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ /**
47
+ * 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\"
48
+ * @summary Retrieve the Commission Agreement Account Mapping
49
+ * @param {string} commissionAgreementCode
50
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
51
+ * @param {*} [options] Override http request option.
52
+ * @throws {RequiredError}
53
+ */
54
+ getCommissionAgreementAccountMapping: (commissionAgreementCode: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
55
+ /**
56
+ * 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\"
57
+ * @summary List Commission Account Mappings
58
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
59
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
60
+ * @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.
61
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
62
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
63
+ * @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.
64
+ * @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.
65
+ * @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.
66
+ * @param {*} [options] Override http request option.
67
+ * @throws {RequiredError}
68
+ */
69
+ listCommissionAccountMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
70
+ /**
71
+ * 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\"
72
+ * @summary List Commission Agreements With Account Mappings
73
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
74
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
75
+ * @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.
76
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
77
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
78
+ * @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.
79
+ * @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.
80
+ * @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.
81
+ * @param {*} [options] Override http request option.
82
+ * @throws {RequiredError}
83
+ */
84
+ listCommissionAgreementsWithAccountMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
85
+ /**
86
+ * 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\"
87
+ * @summary List Commission Type Standards
88
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
89
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
90
+ * @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.
91
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
92
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
93
+ * @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.
94
+ * @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.
95
+ * @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.
96
+ * @param {*} [options] Override http request option.
97
+ * @throws {RequiredError}
98
+ */
99
+ listCommissionTypeAccountMappings: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
100
+ /**
101
+ * 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\"
102
+ * @summary Update the Commission Agreement Account
103
+ * @param {string} commissionAgreementCode
104
+ * @param {string} commissionType
105
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
106
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
107
+ * @param {*} [options] Override http request option.
108
+ * @throws {RequiredError}
109
+ */
110
+ updateCommissionAgreementAccount: (commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
111
+ /**
112
+ * 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\"
113
+ * @summary Update the Commission Type Account
114
+ * @param {string} commissionType
115
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
116
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
117
+ * @param {*} [options] Override http request option.
118
+ * @throws {RequiredError}
119
+ */
120
+ updateCommissionTypeAccount: (commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
121
+ };
122
+ /**
123
+ * CommissionAccountMappingsApi - functional programming interface
124
+ * @export
125
+ */
126
+ export declare const CommissionAccountMappingsApiFp: (configuration?: Configuration) => {
127
+ /**
128
+ * 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\"
129
+ * @summary Delete the Commission Agreement Account
130
+ * @param {string} commissionAgreementCode
131
+ * @param {string} commissionType
132
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
133
+ * @param {*} [options] Override http request option.
134
+ * @throws {RequiredError}
135
+ */
136
+ deleteCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
137
+ /**
138
+ * 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\"
139
+ * @summary Delete the Commission Type Account
140
+ * @param {string} commissionType
141
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
142
+ * @param {*} [options] Override http request option.
143
+ * @throws {RequiredError}
144
+ */
145
+ deleteCommissionTypeAccount(commissionType: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
146
+ /**
147
+ * 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\"
148
+ * @summary Retrieve the Commission Agreement Account Mapping
149
+ * @param {string} commissionAgreementCode
150
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ getCommissionAgreementAccountMapping(commissionAgreementCode: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CommissionAgreementAccountMappingDetailClass>>;
155
+ /**
156
+ * 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\"
157
+ * @summary List Commission Account Mappings
158
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
159
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
160
+ * @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.
161
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
162
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
163
+ * @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.
164
+ * @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.
165
+ * @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.
166
+ * @param {*} [options] Override http request option.
167
+ * @throws {RequiredError}
168
+ */
169
+ 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>>;
170
+ /**
171
+ * 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\"
172
+ * @summary List Commission Agreements With Account Mappings
173
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
174
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
175
+ * @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.
176
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
177
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
178
+ * @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.
179
+ * @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.
180
+ * @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.
181
+ * @param {*} [options] Override http request option.
182
+ * @throws {RequiredError}
183
+ */
184
+ 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>>;
185
+ /**
186
+ * 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\"
187
+ * @summary List Commission Type Standards
188
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
189
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
190
+ * @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.
191
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
192
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
193
+ * @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.
194
+ * @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.
195
+ * @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.
196
+ * @param {*} [options] Override http request option.
197
+ * @throws {RequiredError}
198
+ */
199
+ 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>>;
200
+ /**
201
+ * 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\"
202
+ * @summary Update the Commission Agreement Account
203
+ * @param {string} commissionAgreementCode
204
+ * @param {string} commissionType
205
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
206
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
207
+ * @param {*} [options] Override http request option.
208
+ * @throws {RequiredError}
209
+ */
210
+ updateCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResolvedCommissionAccountMappingClass>>;
211
+ /**
212
+ * 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\"
213
+ * @summary Update the Commission Type Account
214
+ * @param {string} commissionType
215
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
216
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
217
+ * @param {*} [options] Override http request option.
218
+ * @throws {RequiredError}
219
+ */
220
+ updateCommissionTypeAccount(commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ResolvedCommissionAccountMappingClass>>;
221
+ };
222
+ /**
223
+ * CommissionAccountMappingsApi - factory interface
224
+ * @export
225
+ */
226
+ export declare const CommissionAccountMappingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
227
+ /**
228
+ * 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\"
229
+ * @summary Delete the Commission Agreement Account
230
+ * @param {string} commissionAgreementCode
231
+ * @param {string} commissionType
232
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
236
+ deleteCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, authorization?: string, options?: any): AxiosPromise<void>;
237
+ /**
238
+ * 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\"
239
+ * @summary Delete the Commission Type Account
240
+ * @param {string} commissionType
241
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
242
+ * @param {*} [options] Override http request option.
243
+ * @throws {RequiredError}
244
+ */
245
+ deleteCommissionTypeAccount(commissionType: string, authorization?: string, options?: any): AxiosPromise<void>;
246
+ /**
247
+ * 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\"
248
+ * @summary Retrieve the Commission Agreement Account Mapping
249
+ * @param {string} commissionAgreementCode
250
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
251
+ * @param {*} [options] Override http request option.
252
+ * @throws {RequiredError}
253
+ */
254
+ getCommissionAgreementAccountMapping(commissionAgreementCode: string, authorization?: string, options?: any): AxiosPromise<CommissionAgreementAccountMappingDetailClass>;
255
+ /**
256
+ * 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\"
257
+ * @summary List Commission Account Mappings
258
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
259
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
260
+ * @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.
261
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
262
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
263
+ * @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.
264
+ * @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.
265
+ * @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.
266
+ * @param {*} [options] Override http request option.
267
+ * @throws {RequiredError}
268
+ */
269
+ listCommissionAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAccountMappingsResponseClass>;
270
+ /**
271
+ * 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\"
272
+ * @summary List Commission Agreements With Account Mappings
273
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
274
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
275
+ * @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.
276
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
277
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
278
+ * @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.
279
+ * @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.
280
+ * @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.
281
+ * @param {*} [options] Override http request option.
282
+ * @throws {RequiredError}
283
+ */
284
+ listCommissionAgreementsWithAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionAgreementsWithAccountMappingsResponseClass>;
285
+ /**
286
+ * 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\"
287
+ * @summary List Commission Type Standards
288
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
289
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
290
+ * @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.
291
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
292
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
293
+ * @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.
294
+ * @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.
295
+ * @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.
296
+ * @param {*} [options] Override http request option.
297
+ * @throws {RequiredError}
298
+ */
299
+ listCommissionTypeAccountMappings(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionTypeAccountMappingsResponseClass>;
300
+ /**
301
+ * 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\"
302
+ * @summary Update the Commission Agreement Account
303
+ * @param {string} commissionAgreementCode
304
+ * @param {string} commissionType
305
+ * @param {UpdateCommissionAgreementAccountBodyDto} updateCommissionAgreementAccountBodyDto
306
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
307
+ * @param {*} [options] Override http request option.
308
+ * @throws {RequiredError}
309
+ */
310
+ updateCommissionAgreementAccount(commissionAgreementCode: string, commissionType: string, updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto, authorization?: string, options?: any): AxiosPromise<ResolvedCommissionAccountMappingClass>;
311
+ /**
312
+ * 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\"
313
+ * @summary Update the Commission Type Account
314
+ * @param {string} commissionType
315
+ * @param {UpdateCommissionTypeAccountBodyDto} updateCommissionTypeAccountBodyDto
316
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
317
+ * @param {*} [options] Override http request option.
318
+ * @throws {RequiredError}
319
+ */
320
+ updateCommissionTypeAccount(commissionType: string, updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto, authorization?: string, options?: any): AxiosPromise<ResolvedCommissionAccountMappingClass>;
321
+ };
322
+ /**
323
+ * Request parameters for deleteCommissionAgreementAccount operation in CommissionAccountMappingsApi.
324
+ * @export
325
+ * @interface CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest
326
+ */
327
+ export interface CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest {
328
+ /**
329
+ *
330
+ * @type {string}
331
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
332
+ */
333
+ readonly commissionAgreementCode: string;
334
+ /**
335
+ *
336
+ * @type {string}
337
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
338
+ */
339
+ readonly commissionType: string;
340
+ /**
341
+ * Bearer Token: provided by the login endpoint under the name accessToken.
342
+ * @type {string}
343
+ * @memberof CommissionAccountMappingsApiDeleteCommissionAgreementAccount
344
+ */
345
+ readonly authorization?: string;
346
+ }
347
+ /**
348
+ * Request parameters for deleteCommissionTypeAccount operation in CommissionAccountMappingsApi.
349
+ * @export
350
+ * @interface CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest
351
+ */
352
+ export interface CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest {
353
+ /**
354
+ *
355
+ * @type {string}
356
+ * @memberof CommissionAccountMappingsApiDeleteCommissionTypeAccount
357
+ */
358
+ readonly commissionType: string;
359
+ /**
360
+ * Bearer Token: provided by the login endpoint under the name accessToken.
361
+ * @type {string}
362
+ * @memberof CommissionAccountMappingsApiDeleteCommissionTypeAccount
363
+ */
364
+ readonly authorization?: string;
365
+ }
366
+ /**
367
+ * Request parameters for getCommissionAgreementAccountMapping operation in CommissionAccountMappingsApi.
368
+ * @export
369
+ * @interface CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest
370
+ */
371
+ export interface CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest {
372
+ /**
373
+ *
374
+ * @type {string}
375
+ * @memberof CommissionAccountMappingsApiGetCommissionAgreementAccountMapping
376
+ */
377
+ readonly commissionAgreementCode: string;
378
+ /**
379
+ * Bearer Token: provided by the login endpoint under the name accessToken.
380
+ * @type {string}
381
+ * @memberof CommissionAccountMappingsApiGetCommissionAgreementAccountMapping
382
+ */
383
+ readonly authorization?: string;
384
+ }
385
+ /**
386
+ * Request parameters for listCommissionAccountMappings operation in CommissionAccountMappingsApi.
387
+ * @export
388
+ * @interface CommissionAccountMappingsApiListCommissionAccountMappingsRequest
389
+ */
390
+ export interface CommissionAccountMappingsApiListCommissionAccountMappingsRequest {
391
+ /**
392
+ * Bearer Token: provided by the login endpoint under the name accessToken.
393
+ * @type {string}
394
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
395
+ */
396
+ readonly authorization?: string;
397
+ /**
398
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
399
+ * @type {number}
400
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
401
+ */
402
+ readonly pageSize?: number;
403
+ /**
404
+ * 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.
405
+ * @type {string}
406
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
407
+ */
408
+ readonly pageToken?: string;
409
+ /**
410
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
411
+ * @type {string}
412
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
413
+ */
414
+ readonly filter?: string;
415
+ /**
416
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
417
+ * @type {string}
418
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
419
+ */
420
+ readonly search?: string;
421
+ /**
422
+ * 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.
423
+ * @type {string}
424
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
425
+ */
426
+ readonly order?: string;
427
+ /**
428
+ * 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.
429
+ * @type {string}
430
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
431
+ */
432
+ readonly expand?: string;
433
+ /**
434
+ * 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.
435
+ * @type {string}
436
+ * @memberof CommissionAccountMappingsApiListCommissionAccountMappings
437
+ */
438
+ readonly filters?: string;
439
+ }
440
+ /**
441
+ * Request parameters for listCommissionAgreementsWithAccountMappings operation in CommissionAccountMappingsApi.
442
+ * @export
443
+ * @interface CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest
444
+ */
445
+ export interface CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest {
446
+ /**
447
+ * Bearer Token: provided by the login endpoint under the name accessToken.
448
+ * @type {string}
449
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
450
+ */
451
+ readonly authorization?: string;
452
+ /**
453
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
454
+ * @type {number}
455
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
456
+ */
457
+ readonly pageSize?: number;
458
+ /**
459
+ * 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.
460
+ * @type {string}
461
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
462
+ */
463
+ readonly pageToken?: string;
464
+ /**
465
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
466
+ * @type {string}
467
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
468
+ */
469
+ readonly filter?: string;
470
+ /**
471
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
472
+ * @type {string}
473
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
474
+ */
475
+ readonly search?: string;
476
+ /**
477
+ * 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.
478
+ * @type {string}
479
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
480
+ */
481
+ readonly order?: string;
482
+ /**
483
+ * 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.
484
+ * @type {string}
485
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
486
+ */
487
+ readonly expand?: string;
488
+ /**
489
+ * 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.
490
+ * @type {string}
491
+ * @memberof CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappings
492
+ */
493
+ readonly filters?: string;
494
+ }
495
+ /**
496
+ * Request parameters for listCommissionTypeAccountMappings operation in CommissionAccountMappingsApi.
497
+ * @export
498
+ * @interface CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest
499
+ */
500
+ export interface CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest {
501
+ /**
502
+ * Bearer Token: provided by the login endpoint under the name accessToken.
503
+ * @type {string}
504
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
505
+ */
506
+ readonly authorization?: string;
507
+ /**
508
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
509
+ * @type {number}
510
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
511
+ */
512
+ readonly pageSize?: number;
513
+ /**
514
+ * 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.
515
+ * @type {string}
516
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
517
+ */
518
+ readonly pageToken?: string;
519
+ /**
520
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
521
+ * @type {string}
522
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
523
+ */
524
+ readonly filter?: string;
525
+ /**
526
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
527
+ * @type {string}
528
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
529
+ */
530
+ readonly search?: string;
531
+ /**
532
+ * 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.
533
+ * @type {string}
534
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
535
+ */
536
+ readonly order?: string;
537
+ /**
538
+ * 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.
539
+ * @type {string}
540
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
541
+ */
542
+ readonly expand?: string;
543
+ /**
544
+ * 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.
545
+ * @type {string}
546
+ * @memberof CommissionAccountMappingsApiListCommissionTypeAccountMappings
547
+ */
548
+ readonly filters?: string;
549
+ }
550
+ /**
551
+ * Request parameters for updateCommissionAgreementAccount operation in CommissionAccountMappingsApi.
552
+ * @export
553
+ * @interface CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest
554
+ */
555
+ export interface CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest {
556
+ /**
557
+ *
558
+ * @type {string}
559
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
560
+ */
561
+ readonly commissionAgreementCode: string;
562
+ /**
563
+ *
564
+ * @type {string}
565
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
566
+ */
567
+ readonly commissionType: string;
568
+ /**
569
+ *
570
+ * @type {UpdateCommissionAgreementAccountBodyDto}
571
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
572
+ */
573
+ readonly updateCommissionAgreementAccountBodyDto: UpdateCommissionAgreementAccountBodyDto;
574
+ /**
575
+ * Bearer Token: provided by the login endpoint under the name accessToken.
576
+ * @type {string}
577
+ * @memberof CommissionAccountMappingsApiUpdateCommissionAgreementAccount
578
+ */
579
+ readonly authorization?: string;
580
+ }
581
+ /**
582
+ * Request parameters for updateCommissionTypeAccount operation in CommissionAccountMappingsApi.
583
+ * @export
584
+ * @interface CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest
585
+ */
586
+ export interface CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest {
587
+ /**
588
+ *
589
+ * @type {string}
590
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
591
+ */
592
+ readonly commissionType: string;
593
+ /**
594
+ *
595
+ * @type {UpdateCommissionTypeAccountBodyDto}
596
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
597
+ */
598
+ readonly updateCommissionTypeAccountBodyDto: UpdateCommissionTypeAccountBodyDto;
599
+ /**
600
+ * Bearer Token: provided by the login endpoint under the name accessToken.
601
+ * @type {string}
602
+ * @memberof CommissionAccountMappingsApiUpdateCommissionTypeAccount
603
+ */
604
+ readonly authorization?: string;
605
+ }
606
+ /**
607
+ * CommissionAccountMappingsApi - object-oriented interface
608
+ * @export
609
+ * @class CommissionAccountMappingsApi
610
+ * @extends {BaseAPI}
611
+ */
612
+ export declare class CommissionAccountMappingsApi extends BaseAPI {
613
+ /**
614
+ * 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\"
615
+ * @summary Delete the Commission Agreement Account
616
+ * @param {CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest} requestParameters Request parameters.
617
+ * @param {*} [options] Override http request option.
618
+ * @throws {RequiredError}
619
+ * @memberof CommissionAccountMappingsApi
620
+ */
621
+ deleteCommissionAgreementAccount(requestParameters: CommissionAccountMappingsApiDeleteCommissionAgreementAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
622
+ /**
623
+ * 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\"
624
+ * @summary Delete the Commission Type Account
625
+ * @param {CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest} requestParameters Request parameters.
626
+ * @param {*} [options] Override http request option.
627
+ * @throws {RequiredError}
628
+ * @memberof CommissionAccountMappingsApi
629
+ */
630
+ deleteCommissionTypeAccount(requestParameters: CommissionAccountMappingsApiDeleteCommissionTypeAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
631
+ /**
632
+ * 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\"
633
+ * @summary Retrieve the Commission Agreement Account Mapping
634
+ * @param {CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest} requestParameters Request parameters.
635
+ * @param {*} [options] Override http request option.
636
+ * @throws {RequiredError}
637
+ * @memberof CommissionAccountMappingsApi
638
+ */
639
+ getCommissionAgreementAccountMapping(requestParameters: CommissionAccountMappingsApiGetCommissionAgreementAccountMappingRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CommissionAgreementAccountMappingDetailClass, any, {}>>;
640
+ /**
641
+ * 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\"
642
+ * @summary List Commission Account Mappings
643
+ * @param {CommissionAccountMappingsApiListCommissionAccountMappingsRequest} requestParameters Request parameters.
644
+ * @param {*} [options] Override http request option.
645
+ * @throws {RequiredError}
646
+ * @memberof CommissionAccountMappingsApi
647
+ */
648
+ listCommissionAccountMappings(requestParameters?: CommissionAccountMappingsApiListCommissionAccountMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAccountMappingsResponseClass, any, {}>>;
649
+ /**
650
+ * 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\"
651
+ * @summary List Commission Agreements With Account Mappings
652
+ * @param {CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest} requestParameters Request parameters.
653
+ * @param {*} [options] Override http request option.
654
+ * @throws {RequiredError}
655
+ * @memberof CommissionAccountMappingsApi
656
+ */
657
+ listCommissionAgreementsWithAccountMappings(requestParameters?: CommissionAccountMappingsApiListCommissionAgreementsWithAccountMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionAgreementsWithAccountMappingsResponseClass, any, {}>>;
658
+ /**
659
+ * 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\"
660
+ * @summary List Commission Type Standards
661
+ * @param {CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest} requestParameters Request parameters.
662
+ * @param {*} [options] Override http request option.
663
+ * @throws {RequiredError}
664
+ * @memberof CommissionAccountMappingsApi
665
+ */
666
+ listCommissionTypeAccountMappings(requestParameters?: CommissionAccountMappingsApiListCommissionTypeAccountMappingsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionTypeAccountMappingsResponseClass, any, {}>>;
667
+ /**
668
+ * 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\"
669
+ * @summary Update the Commission Agreement Account
670
+ * @param {CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest} requestParameters Request parameters.
671
+ * @param {*} [options] Override http request option.
672
+ * @throws {RequiredError}
673
+ * @memberof CommissionAccountMappingsApi
674
+ */
675
+ updateCommissionAgreementAccount(requestParameters: CommissionAccountMappingsApiUpdateCommissionAgreementAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResolvedCommissionAccountMappingClass, any, {}>>;
676
+ /**
677
+ * 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\"
678
+ * @summary Update the Commission Type Account
679
+ * @param {CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest} requestParameters Request parameters.
680
+ * @param {*} [options] Override http request option.
681
+ * @throws {RequiredError}
682
+ * @memberof CommissionAccountMappingsApi
683
+ */
684
+ updateCommissionTypeAccount(requestParameters: CommissionAccountMappingsApiUpdateCommissionTypeAccountRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ResolvedCommissionAccountMappingClass, any, {}>>;
685
+ }