@emilgroup/commission-sdk-node 2.9.1-beta.13 → 2.9.1-beta.130

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 (102) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-products-api.ts +4 -4
  4. package/api/commission-agreement-rules-api.ts +24 -10
  5. package/api/commission-agreement-versions-api.ts +4 -4
  6. package/api/commission-agreements-api.ts +4 -4
  7. package/api/commission-candidates-api.ts +4 -4
  8. package/api/commission-recipients-api.ts +4 -4
  9. package/api/commission-settlements-api.ts +13 -13
  10. package/api/commissions-api.ts +196 -8
  11. package/dist/api/commission-agreement-products-api.d.ts +4 -4
  12. package/dist/api/commission-agreement-products-api.js +3 -3
  13. package/dist/api/commission-agreement-rules-api.d.ts +16 -7
  14. package/dist/api/commission-agreement-rules-api.js +15 -9
  15. package/dist/api/commission-agreement-versions-api.d.ts +4 -4
  16. package/dist/api/commission-agreement-versions-api.js +3 -3
  17. package/dist/api/commission-agreements-api.d.ts +4 -4
  18. package/dist/api/commission-agreements-api.js +3 -3
  19. package/dist/api/commission-candidates-api.d.ts +4 -4
  20. package/dist/api/commission-candidates-api.js +3 -3
  21. package/dist/api/commission-recipients-api.d.ts +4 -4
  22. package/dist/api/commission-recipients-api.js +3 -3
  23. package/dist/api/commission-settlements-api.d.ts +13 -13
  24. package/dist/api/commission-settlements-api.js +6 -6
  25. package/dist/api/commissions-api.d.ts +118 -8
  26. package/dist/api/commissions-api.js +132 -3
  27. package/dist/models/clawback-config-class.d.ts +6 -0
  28. package/dist/models/clawback-config-dto.d.ts +6 -0
  29. package/dist/models/commission-agreement-class.d.ts +2 -2
  30. package/dist/models/commission-agreement-class.js +1 -1
  31. package/dist/models/commission-agreement-rule-config-dto.d.ts +7 -0
  32. package/dist/models/commission-agreement-version-class.d.ts +4 -4
  33. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  34. package/dist/models/commission-agreement-version-config-class.js +15 -0
  35. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  36. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  37. package/dist/models/commission-class.d.ts +15 -7
  38. package/dist/models/commission-class.js +3 -1
  39. package/dist/models/commission-creation-config-class.d.ts +43 -0
  40. package/dist/models/commission-creation-config-class.js +20 -0
  41. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  42. package/dist/models/commission-creation-config-dto.js +20 -0
  43. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  44. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  45. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  46. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  47. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  48. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  49. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  50. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  51. package/dist/models/commission-estimate-class.d.ts +24 -0
  52. package/dist/models/commission-item-class.d.ts +18 -0
  53. package/dist/models/commission-paid-invoice-entry-class.d.ts +115 -0
  54. package/dist/models/commission-paid-invoice-entry-class.js +22 -0
  55. package/dist/models/commission-payout-config-dto.d.ts +29 -0
  56. package/dist/models/commission-payout-config-dto.js +20 -0
  57. package/dist/models/create-commission-agreement-request-dto.d.ts +5 -5
  58. package/dist/models/create-commission-agreement-request-dto.js +1 -1
  59. package/dist/models/create-commission-agreement-version-request-dto.d.ts +4 -4
  60. package/dist/models/create-commission-item-request-dto.d.ts +24 -0
  61. package/dist/models/estimate-commissions-request-dto.d.ts +6 -0
  62. package/dist/models/index.d.ts +11 -0
  63. package/dist/models/index.js +11 -0
  64. package/dist/models/list-commission-agreement-versions-response-class.d.ts +10 -10
  65. package/dist/models/list-commission-agreements-response-class.d.ts +10 -10
  66. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  67. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  68. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +1 -0
  69. package/dist/models/scheduled-commission-clawback-trigger-class.js +2 -1
  70. package/dist/models/update-commission-agreement-request-dto.d.ts +2 -2
  71. package/dist/models/update-commission-agreement-request-dto.js +1 -1
  72. package/dist/models/update-commission-request-dto.d.ts +1 -1
  73. package/models/clawback-config-class.ts +6 -0
  74. package/models/clawback-config-dto.ts +6 -0
  75. package/models/commission-agreement-class.ts +2 -2
  76. package/models/commission-agreement-rule-config-dto.ts +7 -0
  77. package/models/commission-agreement-version-class.ts +4 -4
  78. package/models/commission-agreement-version-config-class.ts +38 -0
  79. package/models/commission-agreement-version-config-dto.ts +38 -0
  80. package/models/commission-class.ts +16 -8
  81. package/models/commission-creation-config-class.ts +52 -0
  82. package/models/commission-creation-config-dto.ts +52 -0
  83. package/models/commission-creation-invoice-config-class.ts +30 -0
  84. package/models/commission-creation-invoice-config-dto.ts +30 -0
  85. package/models/commission-creation-renewal-config-class.ts +38 -0
  86. package/models/commission-creation-renewal-config-dto.ts +38 -0
  87. package/models/commission-estimate-class.ts +24 -0
  88. package/models/commission-item-class.ts +18 -0
  89. package/models/commission-paid-invoice-entry-class.ts +124 -0
  90. package/models/commission-payout-config-dto.ts +38 -0
  91. package/models/create-commission-agreement-request-dto.ts +5 -5
  92. package/models/create-commission-agreement-version-request-dto.ts +4 -4
  93. package/models/create-commission-item-request-dto.ts +24 -0
  94. package/models/estimate-commissions-request-dto.ts +6 -0
  95. package/models/index.ts +11 -0
  96. package/models/list-commission-agreement-versions-response-class.ts +10 -10
  97. package/models/list-commission-agreements-response-class.ts +10 -10
  98. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  99. package/models/scheduled-commission-clawback-trigger-class.ts +2 -1
  100. package/models/update-commission-agreement-request-dto.ts +2 -2
  101. package/models/update-commission-request-dto.ts +1 -1
  102. package/package.json +1 -1
@@ -19,6 +19,7 @@ import { CreateCommissionResponseClass } from '../models';
19
19
  import { EstimateCommissionsRequestDto } from '../models';
20
20
  import { EstimateCommissionsResponseClass } from '../models';
21
21
  import { GetCommissionResponseClass } from '../models';
22
+ import { ListCommissionPaidInvoiceEntriesResponseClass } from '../models';
22
23
  import { ListCommissionsResponseClass } from '../models';
23
24
  import { ListScheduledCommissionClawbackTriggersResponseClass } from '../models';
24
25
  import { TriggerDueCommissionClawbacksRequestDto } from '../models';
@@ -77,6 +78,21 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
77
78
  * @throws {RequiredError}
78
79
  */
79
80
  getCommission: (code: string, expand: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
81
+ /**
82
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
83
+ * @summary List commission paid invoice entries
84
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
85
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
86
+ * @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.
87
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
88
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
89
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
90
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
91
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
92
+ * @param {*} [options] Override http request option.
93
+ * @throws {RequiredError}
94
+ */
95
+ listCommissionPaidInvoiceEntries: (authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
80
96
  /**
81
97
  * Retrieves a list of commissions.
82
98
  * @summary List commissions
@@ -85,13 +101,13 @@ export declare const CommissionsApiAxiosParamCreator: (configuration?: Configura
85
101
  * @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.
86
102
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
87
103
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
88
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
104
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
89
105
  * @param {'items' | 'agreement'} [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.
90
106
  * @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.
91
107
  * @param {*} [options] Override http request option.
92
108
  * @throws {RequiredError}
93
109
  */
94
- listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
110
+ listCommissions: (authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
95
111
  /**
96
112
  * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
97
113
  * @summary List scheduled commission clawback triggers
@@ -179,6 +195,21 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
179
195
  * @throws {RequiredError}
180
196
  */
181
197
  getCommission(code: string, expand: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCommissionResponseClass>>;
198
+ /**
199
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
200
+ * @summary List commission paid invoice entries
201
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
202
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
203
+ * @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.
204
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
205
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
206
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
207
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
208
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
209
+ * @param {*} [options] Override http request option.
210
+ * @throws {RequiredError}
211
+ */
212
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>>;
182
213
  /**
183
214
  * Retrieves a list of commissions.
184
215
  * @summary List commissions
@@ -187,13 +218,13 @@ export declare const CommissionsApiFp: (configuration?: Configuration) => {
187
218
  * @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.
188
219
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
189
220
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
190
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
221
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
191
222
  * @param {'items' | 'agreement'} [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.
192
223
  * @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.
193
224
  * @param {*} [options] Override http request option.
194
225
  * @throws {RequiredError}
195
226
  */
196
- listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
227
+ listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id', expand?: 'items' | 'agreement', filters?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListCommissionsResponseClass>>;
197
228
  /**
198
229
  * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
199
230
  * @summary List scheduled commission clawback triggers
@@ -281,6 +312,21 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
281
312
  * @throws {RequiredError}
282
313
  */
283
314
  getCommission(code: string, expand: string, authorization?: string, options?: any): AxiosPromise<GetCommissionResponseClass>;
315
+ /**
316
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
317
+ * @summary List commission paid invoice entries
318
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
319
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
320
+ * @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.
321
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
322
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
323
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
324
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
325
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
326
+ * @param {*} [options] Override http request option.
327
+ * @throws {RequiredError}
328
+ */
329
+ listCommissionPaidInvoiceEntries(authorization?: string, pageSize?: number, pageToken?: string, filter?: string, search?: string, order?: string, expand?: string, filters?: string, options?: any): AxiosPromise<ListCommissionPaidInvoiceEntriesResponseClass>;
284
330
  /**
285
331
  * Retrieves a list of commissions.
286
332
  * @summary List commissions
@@ -289,13 +335,13 @@ export declare const CommissionsApiFactory: (configuration?: Configuration, base
289
335
  * @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.
290
336
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
291
337
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
292
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
338
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
293
339
  * @param {'items' | 'agreement'} [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.
294
340
  * @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.
295
341
  * @param {*} [options] Override http request option.
296
342
  * @throws {RequiredError}
297
343
  */
298
- listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
344
+ listCommissions(authorization?: string, pageSize?: number, pageToken?: string, filter?: 'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode', search?: string, order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id', expand?: 'items' | 'agreement', filters?: string, options?: any): AxiosPromise<ListCommissionsResponseClass>;
299
345
  /**
300
346
  * Returns future-dated commission clawback triggers and their processing status. Use this to check pending, queued, canceled, or failed automatic clawback triggers.
301
347
  * @summary List scheduled commission clawback triggers
@@ -438,6 +484,61 @@ export interface CommissionsApiGetCommissionRequest {
438
484
  */
439
485
  readonly authorization?: string;
440
486
  }
487
+ /**
488
+ * Request parameters for listCommissionPaidInvoiceEntries operation in CommissionsApi.
489
+ * @export
490
+ * @interface CommissionsApiListCommissionPaidInvoiceEntriesRequest
491
+ */
492
+ export interface CommissionsApiListCommissionPaidInvoiceEntriesRequest {
493
+ /**
494
+ * Bearer Token: provided by the login endpoint under the name accessToken.
495
+ * @type {string}
496
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
497
+ */
498
+ readonly authorization?: string;
499
+ /**
500
+ * A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
501
+ * @type {number}
502
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
503
+ */
504
+ readonly pageSize?: number;
505
+ /**
506
+ * 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.
507
+ * @type {string}
508
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
509
+ */
510
+ readonly pageToken?: string;
511
+ /**
512
+ * Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
513
+ * @type {string}
514
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
515
+ */
516
+ readonly filter?: string;
517
+ /**
518
+ * To search the list by any field, pass search&#x3D;xxx to fetch the result.
519
+ * @type {string}
520
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
521
+ */
522
+ readonly search?: string;
523
+ /**
524
+ * Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
525
+ * @type {string}
526
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
527
+ */
528
+ readonly order?: string;
529
+ /**
530
+ * Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
531
+ * @type {string}
532
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
533
+ */
534
+ readonly expand?: string;
535
+ /**
536
+ * Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
537
+ * @type {string}
538
+ * @memberof CommissionsApiListCommissionPaidInvoiceEntries
539
+ */
540
+ readonly filters?: string;
541
+ }
441
542
  /**
442
543
  * Request parameters for listCommissions operation in CommissionsApi.
443
544
  * @export
@@ -476,10 +577,10 @@ export interface CommissionsApiListCommissionsRequest {
476
577
  readonly search?: string;
477
578
  /**
478
579
  * 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.
479
- * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'}
580
+ * @type {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'}
480
581
  * @memberof CommissionsApiListCommissions
481
582
  */
482
- readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency';
583
+ readonly order?: 'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id';
483
584
  /**
484
585
  * 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.
485
586
  * @type {'items' | 'agreement'}
@@ -644,6 +745,15 @@ export declare class CommissionsApi extends BaseAPI {
644
745
  * @memberof CommissionsApi
645
746
  */
646
747
  getCommission(requestParameters: CommissionsApiGetCommissionRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetCommissionResponseClass, any, {}>>;
748
+ /**
749
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
750
+ * @summary List commission paid invoice entries
751
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
752
+ * @param {*} [options] Override http request option.
753
+ * @throws {RequiredError}
754
+ * @memberof CommissionsApi
755
+ */
756
+ listCommissionPaidInvoiceEntries(requestParameters?: CommissionsApiListCommissionPaidInvoiceEntriesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListCommissionPaidInvoiceEntriesResponseClass, any, {}>>;
647
757
  /**
648
758
  * Retrieves a list of commissions.
649
759
  * @summary List commissions
@@ -349,6 +349,78 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
349
349
  });
350
350
  });
351
351
  },
352
+ /**
353
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
354
+ * @summary List commission paid invoice entries
355
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
356
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
357
+ * @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.
358
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
359
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
360
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
361
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
362
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
363
+ * @param {*} [options] Override http request option.
364
+ * @throws {RequiredError}
365
+ */
366
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
367
+ if (options === void 0) { options = {}; }
368
+ return __awaiter(_this, void 0, void 0, function () {
369
+ var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
370
+ return __generator(this, function (_a) {
371
+ switch (_a.label) {
372
+ case 0:
373
+ localVarPath = "/commissionservice/v1/commissions/paid-invoice-entries";
374
+ localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
375
+ if (configuration) {
376
+ baseOptions = configuration.baseOptions;
377
+ baseAccessToken = configuration.accessToken;
378
+ }
379
+ localVarRequestOptions = __assign(__assign({ method: 'GET' }, baseOptions), options);
380
+ localVarHeaderParameter = {};
381
+ localVarQueryParameter = {};
382
+ // authentication bearer required
383
+ // http bearer authentication required
384
+ return [4 /*yield*/, (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration)];
385
+ case 1:
386
+ // authentication bearer required
387
+ // http bearer authentication required
388
+ _a.sent();
389
+ if (pageSize !== undefined) {
390
+ localVarQueryParameter['pageSize'] = pageSize;
391
+ }
392
+ if (pageToken !== undefined) {
393
+ localVarQueryParameter['pageToken'] = pageToken;
394
+ }
395
+ if (filter !== undefined) {
396
+ localVarQueryParameter['filter'] = filter;
397
+ }
398
+ if (search !== undefined) {
399
+ localVarQueryParameter['search'] = search;
400
+ }
401
+ if (order !== undefined) {
402
+ localVarQueryParameter['order'] = order;
403
+ }
404
+ if (expand !== undefined) {
405
+ localVarQueryParameter['expand'] = expand;
406
+ }
407
+ if (filters !== undefined) {
408
+ localVarQueryParameter['filters'] = filters;
409
+ }
410
+ if (authorization !== undefined && authorization !== null || baseAccessToken !== undefined && baseAccessToken !== null) {
411
+ localVarHeaderParameter['Authorization'] = String(authorization ? authorization : baseAccessToken);
412
+ }
413
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
414
+ headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
415
+ localVarRequestOptions.headers = __assign(__assign(__assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
416
+ return [2 /*return*/, {
417
+ url: (0, common_1.toPathString)(localVarUrlObj),
418
+ options: localVarRequestOptions,
419
+ }];
420
+ }
421
+ });
422
+ });
423
+ },
352
424
  /**
353
425
  * Retrieves a list of commissions.
354
426
  * @summary List commissions
@@ -357,7 +429,7 @@ var CommissionsApiAxiosParamCreator = function (configuration) {
357
429
  * @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.
358
430
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
359
431
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
360
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
432
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
361
433
  * @param {'items' | 'agreement'} [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.
362
434
  * @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.
363
435
  * @param {*} [options] Override http request option.
@@ -712,6 +784,33 @@ var CommissionsApiFp = function (configuration) {
712
784
  });
713
785
  });
714
786
  },
787
+ /**
788
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
789
+ * @summary List commission paid invoice entries
790
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
791
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
792
+ * @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.
793
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
794
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
795
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
796
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
797
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
798
+ * @param {*} [options] Override http request option.
799
+ * @throws {RequiredError}
800
+ */
801
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
802
+ return __awaiter(this, void 0, void 0, function () {
803
+ var localVarAxiosArgs;
804
+ return __generator(this, function (_a) {
805
+ switch (_a.label) {
806
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options)];
807
+ case 1:
808
+ localVarAxiosArgs = _a.sent();
809
+ return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
810
+ }
811
+ });
812
+ });
813
+ },
715
814
  /**
716
815
  * Retrieves a list of commissions.
717
816
  * @summary List commissions
@@ -720,7 +819,7 @@ var CommissionsApiFp = function (configuration) {
720
819
  * @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.
721
820
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
722
821
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
723
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
822
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
724
823
  * @param {'items' | 'agreement'} [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.
725
824
  * @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.
726
825
  * @param {*} [options] Override http request option.
@@ -876,6 +975,23 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
876
975
  getCommission: function (code, expand, authorization, options) {
877
976
  return localVarFp.getCommission(code, expand, authorization, options).then(function (request) { return request(axios, basePath); });
878
977
  },
978
+ /**
979
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
980
+ * @summary List commission paid invoice entries
981
+ * @param {string} [authorization] Bearer Token: provided by the login endpoint under the name accessToken.
982
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 50. Default: 10.
983
+ * @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.
984
+ * @param {string} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
985
+ * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
986
+ * @param {string} [order] Order allows you to specify the desired order of entities retrieved from the server by ascending (ASC) or descending (DESC) order.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, createdAt, updatedAt, policyTimesliceFrom, policyTimesliceTo&lt;/i&gt;
987
+ * @param {string} [expand] Expand to fetch additional information about the list items. Expanding resources can reduce the number of API calls required to accomplish a task. Use with discretion as some expanded fields can drastically increase payload size.&lt;br/&gt; &lt;br/&gt;
988
+ * @param {string} [filters] Filters the response by one or multiple fields. Advanced filter functionality allows you to perform more complex filtering operations.&lt;br/&gt; &lt;br/&gt; &lt;i&gt;Allowed values: id, code, policyCode, invoiceCode, commissionAgreementVersionCode, policyTimesliceFrom, policyTimesliceTo, status, commissionCandidateCode, commissionCode, createdAt, updatedAt, createdBy, updatedBy&lt;/i&gt;
989
+ * @param {*} [options] Override http request option.
990
+ * @throws {RequiredError}
991
+ */
992
+ listCommissionPaidInvoiceEntries: function (authorization, pageSize, pageToken, filter, search, order, expand, filters, options) {
993
+ return localVarFp.listCommissionPaidInvoiceEntries(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then(function (request) { return request(axios, basePath); });
994
+ },
879
995
  /**
880
996
  * Retrieves a list of commissions.
881
997
  * @summary List commissions
@@ -884,7 +1000,7 @@ var CommissionsApiFactory = function (configuration, basePath, axios) {
884
1000
  * @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.
885
1001
  * @param {'id' | 'code' | 'partnerCode' | 'policyCode' | 'commissionAgreementCode' | 'commissionAgreementNumber' | 'commissionAgreementVersionId' | 'status' | 'amount' | 'description' | 'createdBy' | 'updatedBy' | 'createdAt' | 'openedAt' | 'updatedAt' | 'settlementCode'} [filter] Filter the response by one or multiple fields. In general, fetching filtered responses will conserve bandwidth and reduce response time.
886
1002
  * @param {string} [search] To search the list by any field, pass search&#x3D;xxx to fetch the result.
887
- * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency'} [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.
1003
+ * @param {'commissionAgreementNumber' | 'policyNumber' | 'partnerNumber' | 'createdAt' | 'openedAt' | 'updatedAt' | 'amount' | 'status' | 'agreement.billingFrequency' | 'id'} [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.
888
1004
  * @param {'items' | 'agreement'} [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.
889
1005
  * @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.
890
1006
  * @param {*} [options] Override http request option.
@@ -1007,6 +1123,19 @@ var CommissionsApi = /** @class */ (function (_super) {
1007
1123
  var _this = this;
1008
1124
  return (0, exports.CommissionsApiFp)(this.configuration).getCommission(requestParameters.code, requestParameters.expand, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
1009
1125
  };
1126
+ /**
1127
+ * Returns paid invoices counted for invoice-mode commission creation. Use this endpoint to inspect counted, consumed, and discarded invoice groups.
1128
+ * @summary List commission paid invoice entries
1129
+ * @param {CommissionsApiListCommissionPaidInvoiceEntriesRequest} requestParameters Request parameters.
1130
+ * @param {*} [options] Override http request option.
1131
+ * @throws {RequiredError}
1132
+ * @memberof CommissionsApi
1133
+ */
1134
+ CommissionsApi.prototype.listCommissionPaidInvoiceEntries = function (requestParameters, options) {
1135
+ var _this = this;
1136
+ if (requestParameters === void 0) { requestParameters = {}; }
1137
+ return (0, exports.CommissionsApiFp)(this.configuration).listCommissionPaidInvoiceEntries(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, requestParameters.filters, options).then(function (request) { return request(_this.axios, _this.basePath); });
1138
+ };
1010
1139
  /**
1011
1140
  * Retrieves a list of commissions.
1012
1141
  * @summary List commissions
@@ -33,4 +33,10 @@ export interface ClawbackConfigClass {
33
33
  * @memberof ClawbackConfigClass
34
34
  */
35
35
  'intermediarySwitched': boolean;
36
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigClass
40
+ */
41
+ 'invoiceReopened': boolean;
36
42
  }
@@ -33,4 +33,10 @@ export interface ClawbackConfigDto {
33
33
  * @memberof ClawbackConfigDto
34
34
  */
35
35
  'intermediarySwitched': boolean;
36
+ /**
37
+ * Allow automatic commission clawback creation for reopened invoices.
38
+ * @type {boolean}
39
+ * @memberof ClawbackConfigDto
40
+ */
41
+ 'invoiceReopened': boolean;
36
42
  }
@@ -60,7 +60,7 @@ export interface CommissionAgreementClass {
60
60
  */
61
61
  'description'?: string;
62
62
  /**
63
- * Frequency at which commissions are billed (e.g., immediately, monthly, quarterly, halfYearly, yearly)
63
+ * Frequency at which commissions are billed (e.g., manual, monthly, quarterly, halfYearly, yearly)
64
64
  * @type {string}
65
65
  * @memberof CommissionAgreementClass
66
66
  */
@@ -104,7 +104,7 @@ export declare const CommissionAgreementClassStatusEnum: {
104
104
  };
105
105
  export type CommissionAgreementClassStatusEnum = typeof CommissionAgreementClassStatusEnum[keyof typeof CommissionAgreementClassStatusEnum];
106
106
  export declare const CommissionAgreementClassBillingFrequencyEnum: {
107
- readonly Immediately: "immediately";
107
+ readonly Manual: "manual";
108
108
  readonly Monthly: "monthly";
109
109
  readonly Quarterly: "quarterly";
110
110
  readonly HalfYearly: "halfYearly";
@@ -21,7 +21,7 @@ exports.CommissionAgreementClassStatusEnum = {
21
21
  Archived: 'archived'
22
22
  };
23
23
  exports.CommissionAgreementClassBillingFrequencyEnum = {
24
- Immediately: 'immediately',
24
+ Manual: 'manual',
25
25
  Monthly: 'monthly',
26
26
  Quarterly: 'quarterly',
27
27
  HalfYearly: 'halfYearly',
@@ -10,6 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import { CommissionConfigDto } from './commission-config-dto';
13
+ import { CommissionPayoutConfigDto } from './commission-payout-config-dto';
13
14
  /**
14
15
  *
15
16
  * @export
@@ -22,4 +23,10 @@ export interface CommissionAgreementRuleConfigDto {
22
23
  * @memberof CommissionAgreementRuleConfigDto
23
24
  */
24
25
  'commissions': Array<CommissionConfigDto>;
26
+ /**
27
+ * Who the rule\'s commissions are paid to. When absent, they are paid to the agreement\'s main partner
28
+ * @type {CommissionPayoutConfigDto}
29
+ * @memberof CommissionAgreementRuleConfigDto
30
+ */
31
+ 'payout'?: CommissionPayoutConfigDto;
25
32
  }
@@ -9,9 +9,9 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { ClawbackConfigClass } from './clawback-config-class';
13
12
  import { CommissionAgreementClass } from './commission-agreement-class';
14
13
  import { CommissionAgreementProductClass } from './commission-agreement-product-class';
14
+ import { CommissionAgreementVersionConfigClass } from './commission-agreement-version-config-class';
15
15
  /**
16
16
  *
17
17
  * @export
@@ -61,11 +61,11 @@ export interface CommissionAgreementVersionClass {
61
61
  */
62
62
  'settlementCreationDate'?: string;
63
63
  /**
64
- * Version-scoped clawback creation configuration.
65
- * @type {ClawbackConfigClass}
64
+ * Version-scoped agreement configuration.
65
+ * @type {CommissionAgreementVersionConfigClass}
66
66
  * @memberof CommissionAgreementVersionClass
67
67
  */
68
- 'clawbackConfig': ClawbackConfigClass;
68
+ 'config': CommissionAgreementVersionConfigClass;
69
69
  /**
70
70
  * Description explaining what changed in this version or version notes
71
71
  * @type {string}
@@ -0,0 +1,32 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService 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 { ClawbackConfigClass } from './clawback-config-class';
13
+ import { CommissionCreationConfigClass } from './commission-creation-config-class';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CommissionAgreementVersionConfigClass
18
+ */
19
+ export interface CommissionAgreementVersionConfigClass {
20
+ /**
21
+ * Controls which clawback triggers are enabled for this commission agreement version. Missing values are treated as disabled by default.
22
+ * @type {ClawbackConfigClass}
23
+ * @memberof CommissionAgreementVersionConfigClass
24
+ */
25
+ 'clawback'?: ClawbackConfigClass;
26
+ /**
27
+ * Controls when recurring commission work is created for this commission agreement version. Missing values are treated as renewal mode by default.
28
+ * @type {CommissionCreationConfigClass}
29
+ * @memberof CommissionAgreementVersionConfigClass
30
+ */
31
+ 'commissionCreation'?: CommissionCreationConfigClass;
32
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL CommissionService
6
+ * The EMIL CommissionService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,32 @@
1
+ /**
2
+ * EMIL CommissionService
3
+ * The EMIL CommissionService 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 { ClawbackConfigDto } from './clawback-config-dto';
13
+ import { CommissionCreationConfigDto } from './commission-creation-config-dto';
14
+ /**
15
+ *
16
+ * @export
17
+ * @interface CommissionAgreementVersionConfigDto
18
+ */
19
+ export interface CommissionAgreementVersionConfigDto {
20
+ /**
21
+ * Controls which clawback triggers are enabled for this commission agreement version. Missing values are treated as disabled by default.
22
+ * @type {ClawbackConfigDto}
23
+ * @memberof CommissionAgreementVersionConfigDto
24
+ */
25
+ 'clawback'?: ClawbackConfigDto;
26
+ /**
27
+ * Controls when recurring commission work is created for this commission agreement version. Missing values are treated as renewal mode by default.
28
+ * @type {CommissionCreationConfigDto}
29
+ * @memberof CommissionAgreementVersionConfigDto
30
+ */
31
+ 'commissionCreation'?: CommissionCreationConfigDto;
32
+ }