@emilgroup/commission-sdk 2.10.1-beta.3 → 2.10.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 (106) hide show
  1. package/.openapi-generator/FILES +20 -0
  2. package/README.md +2 -2
  3. package/api/commission-agreement-versions-api.ts +12 -12
  4. package/api/commission-settlements-api.ts +115 -8
  5. package/api/commissions-api.ts +616 -13
  6. package/dist/api/commission-agreement-versions-api.d.ts +12 -12
  7. package/dist/api/commission-agreement-versions-api.js +9 -9
  8. package/dist/api/commission-settlements-api.d.ts +65 -8
  9. package/dist/api/commission-settlements-api.js +96 -3
  10. package/dist/api/commissions-api.d.ts +356 -13
  11. package/dist/api/commissions-api.js +456 -6
  12. package/dist/models/clawback-config-class.d.ts +42 -0
  13. package/dist/models/clawback-config-class.js +15 -0
  14. package/dist/models/clawback-config-dto.d.ts +42 -0
  15. package/dist/models/clawback-config-dto.js +15 -0
  16. package/dist/models/commission-agreement-version-class.d.ts +13 -0
  17. package/dist/models/commission-agreement-version-config-class.d.ts +32 -0
  18. package/dist/models/commission-agreement-version-config-class.js +15 -0
  19. package/dist/models/commission-agreement-version-config-dto.d.ts +32 -0
  20. package/dist/models/commission-agreement-version-config-dto.js +15 -0
  21. package/dist/models/commission-candidate-class.d.ts +12 -0
  22. package/dist/models/commission-class.d.ts +50 -0
  23. package/dist/models/commission-class.js +8 -0
  24. package/dist/models/commission-config-dto.d.ts +2 -1
  25. package/dist/models/commission-config-dto.js +2 -1
  26. package/dist/models/commission-creation-config-class.d.ts +43 -0
  27. package/dist/models/commission-creation-config-class.js +20 -0
  28. package/dist/models/commission-creation-config-dto.d.ts +43 -0
  29. package/dist/models/commission-creation-config-dto.js +20 -0
  30. package/dist/models/commission-creation-invoice-config-class.d.ts +24 -0
  31. package/dist/models/commission-creation-invoice-config-class.js +15 -0
  32. package/dist/models/commission-creation-invoice-config-dto.d.ts +24 -0
  33. package/dist/models/commission-creation-invoice-config-dto.js +15 -0
  34. package/dist/models/commission-creation-renewal-config-class.d.ts +29 -0
  35. package/dist/models/commission-creation-renewal-config-class.js +20 -0
  36. package/dist/models/commission-creation-renewal-config-dto.d.ts +29 -0
  37. package/dist/models/commission-creation-renewal-config-dto.js +20 -0
  38. package/dist/models/commission-estimate-class.d.ts +2 -1
  39. package/dist/models/commission-estimate-class.js +2 -1
  40. package/dist/models/commission-paid-invoice-entry-class.d.ts +108 -0
  41. package/dist/models/commission-paid-invoice-entry-class.js +21 -0
  42. package/dist/models/create-commission-agreement-request-dto.d.ts +13 -0
  43. package/dist/models/create-commission-agreement-version-request-dto.d.ts +13 -0
  44. package/dist/models/create-commission-candidate-request-dto.d.ts +15 -2
  45. package/dist/models/create-commission-candidate-request-dto.js +2 -1
  46. package/dist/models/create-commission-clawback-request-dto.d.ts +24 -0
  47. package/dist/models/create-commission-clawback-request-dto.js +15 -0
  48. package/dist/models/create-commission-clawback-response-class.d.ts +43 -0
  49. package/dist/models/create-commission-clawback-response-class.js +21 -0
  50. package/dist/models/create-commission-item-request-dto.d.ts +2 -1
  51. package/dist/models/create-commission-item-request-dto.js +2 -1
  52. package/dist/models/create-commission-request-dto.d.ts +6 -0
  53. package/dist/models/evaluated-commission-class.d.ts +2 -1
  54. package/dist/models/evaluated-commission-class.js +2 -1
  55. package/dist/models/index.d.ts +20 -0
  56. package/dist/models/index.js +20 -0
  57. package/dist/models/list-commission-paid-invoice-entries-response-class.d.ts +43 -0
  58. package/dist/models/list-commission-paid-invoice-entries-response-class.js +15 -0
  59. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.d.ts +43 -0
  60. package/dist/models/list-scheduled-commission-clawback-triggers-response-class.js +15 -0
  61. package/dist/models/scheduled-commission-clawback-trigger-class.d.ts +110 -0
  62. package/dist/models/scheduled-commission-clawback-trigger-class.js +28 -0
  63. package/dist/models/trigger-commission-settlement-creation-request-dto.d.ts +30 -0
  64. package/dist/models/trigger-commission-settlement-creation-request-dto.js +15 -0
  65. package/dist/models/trigger-commission-settlement-creation-response-class.d.ts +24 -0
  66. package/dist/models/trigger-commission-settlement-creation-response-class.js +15 -0
  67. package/dist/models/trigger-due-commission-clawbacks-request-dto.d.ts +30 -0
  68. package/dist/models/trigger-due-commission-clawbacks-request-dto.js +15 -0
  69. package/dist/models/trigger-due-commission-clawbacks-response-class.d.ts +24 -0
  70. package/dist/models/trigger-due-commission-clawbacks-response-class.js +15 -0
  71. package/dist/models/update-commission-candidate-request-dto.d.ts +2 -1
  72. package/dist/models/update-commission-candidate-request-dto.js +2 -1
  73. package/models/clawback-config-class.ts +48 -0
  74. package/models/clawback-config-dto.ts +48 -0
  75. package/models/commission-agreement-version-class.ts +13 -0
  76. package/models/commission-agreement-version-config-class.ts +38 -0
  77. package/models/commission-agreement-version-config-dto.ts +38 -0
  78. package/models/commission-candidate-class.ts +12 -0
  79. package/models/commission-class.ts +53 -0
  80. package/models/commission-config-dto.ts +3 -2
  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 +3 -2
  88. package/models/commission-paid-invoice-entry-class.ts +117 -0
  89. package/models/create-commission-agreement-request-dto.ts +13 -0
  90. package/models/create-commission-agreement-version-request-dto.ts +13 -0
  91. package/models/create-commission-candidate-request-dto.ts +16 -3
  92. package/models/create-commission-clawback-request-dto.ts +30 -0
  93. package/models/create-commission-clawback-response-class.ts +52 -0
  94. package/models/create-commission-item-request-dto.ts +3 -2
  95. package/models/create-commission-request-dto.ts +6 -0
  96. package/models/evaluated-commission-class.ts +3 -2
  97. package/models/index.ts +20 -0
  98. package/models/list-commission-paid-invoice-entries-response-class.ts +49 -0
  99. package/models/list-scheduled-commission-clawback-triggers-response-class.ts +49 -0
  100. package/models/scheduled-commission-clawback-trigger-class.ts +120 -0
  101. package/models/trigger-commission-settlement-creation-request-dto.ts +36 -0
  102. package/models/trigger-commission-settlement-creation-response-class.ts +30 -0
  103. package/models/trigger-due-commission-clawbacks-request-dto.ts +36 -0
  104. package/models/trigger-due-commission-clawbacks-response-class.ts +30 -0
  105. package/models/update-commission-candidate-request-dto.ts +3 -2
  106. package/package.json +1 -1
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CommissionCreationInvoiceConfigClass } from './commission-creation-invoice-config-class';
17
+ import { CommissionCreationRenewalConfigClass } from './commission-creation-renewal-config-class';
18
+
19
+ /**
20
+ *
21
+ * @export
22
+ * @interface CommissionCreationConfigClass
23
+ */
24
+ export interface CommissionCreationConfigClass {
25
+ /**
26
+ * Determines which event drives recurring commission creation: renewal dates or paid invoices.
27
+ * @type {string}
28
+ * @memberof CommissionCreationConfigClass
29
+ */
30
+ 'mode': CommissionCreationConfigClassModeEnum;
31
+ /**
32
+ * Required when mode is renewal. Defines whether commission work is created only at renewal or yearly inside long policy periods.
33
+ * @type {CommissionCreationRenewalConfigClass}
34
+ * @memberof CommissionCreationConfigClass
35
+ */
36
+ 'renewal'?: CommissionCreationRenewalConfigClass;
37
+ /**
38
+ * Required when mode is invoice. Defines how many paid invoices must be counted before commission work is created.
39
+ * @type {CommissionCreationInvoiceConfigClass}
40
+ * @memberof CommissionCreationConfigClass
41
+ */
42
+ 'invoice'?: CommissionCreationInvoiceConfigClass;
43
+ }
44
+
45
+ export const CommissionCreationConfigClassModeEnum = {
46
+ Renewal: 'renewal',
47
+ Invoice: 'invoice'
48
+ } as const;
49
+
50
+ export type CommissionCreationConfigClassModeEnum = typeof CommissionCreationConfigClassModeEnum[keyof typeof CommissionCreationConfigClassModeEnum];
51
+
52
+
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CommissionCreationInvoiceConfigDto } from './commission-creation-invoice-config-dto';
17
+ import { CommissionCreationRenewalConfigDto } from './commission-creation-renewal-config-dto';
18
+
19
+ /**
20
+ *
21
+ * @export
22
+ * @interface CommissionCreationConfigDto
23
+ */
24
+ export interface CommissionCreationConfigDto {
25
+ /**
26
+ * Determines which event drives recurring commission creation: renewal dates or paid invoices.
27
+ * @type {string}
28
+ * @memberof CommissionCreationConfigDto
29
+ */
30
+ 'mode': CommissionCreationConfigDtoModeEnum;
31
+ /**
32
+ * Required when mode is renewal. Defines whether commission work is created only at renewal or yearly inside long policy periods.
33
+ * @type {CommissionCreationRenewalConfigDto}
34
+ * @memberof CommissionCreationConfigDto
35
+ */
36
+ 'renewal'?: CommissionCreationRenewalConfigDto;
37
+ /**
38
+ * Required when mode is invoice. Defines how many paid invoices must be counted before commission work is created.
39
+ * @type {CommissionCreationInvoiceConfigDto}
40
+ * @memberof CommissionCreationConfigDto
41
+ */
42
+ 'invoice'?: CommissionCreationInvoiceConfigDto;
43
+ }
44
+
45
+ export const CommissionCreationConfigDtoModeEnum = {
46
+ Renewal: 'renewal',
47
+ Invoice: 'invoice'
48
+ } as const;
49
+
50
+ export type CommissionCreationConfigDtoModeEnum = typeof CommissionCreationConfigDtoModeEnum[keyof typeof CommissionCreationConfigDtoModeEnum];
51
+
52
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionCreationInvoiceConfigClass
21
+ */
22
+ export interface CommissionCreationInvoiceConfigClass {
23
+ /**
24
+ * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
25
+ * @type {number}
26
+ * @memberof CommissionCreationInvoiceConfigClass
27
+ */
28
+ 'paidInvoiceInterval': number;
29
+ }
30
+
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionCreationInvoiceConfigDto
21
+ */
22
+ export interface CommissionCreationInvoiceConfigDto {
23
+ /**
24
+ * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
25
+ * @type {number}
26
+ * @memberof CommissionCreationInvoiceConfigDto
27
+ */
28
+ 'paidInvoiceInterval': number;
29
+ }
30
+
@@ -0,0 +1,38 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionCreationRenewalConfigClass
21
+ */
22
+ export interface CommissionCreationRenewalConfigClass {
23
+ /**
24
+ * Renewal mode frequency. Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
25
+ * @type {string}
26
+ * @memberof CommissionCreationRenewalConfigClass
27
+ */
28
+ 'frequency': CommissionCreationRenewalConfigClassFrequencyEnum;
29
+ }
30
+
31
+ export const CommissionCreationRenewalConfigClassFrequencyEnum = {
32
+ Renewal: 'renewal',
33
+ Yearly: 'yearly'
34
+ } as const;
35
+
36
+ export type CommissionCreationRenewalConfigClassFrequencyEnum = typeof CommissionCreationRenewalConfigClassFrequencyEnum[keyof typeof CommissionCreationRenewalConfigClassFrequencyEnum];
37
+
38
+
@@ -0,0 +1,38 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionCreationRenewalConfigDto
21
+ */
22
+ export interface CommissionCreationRenewalConfigDto {
23
+ /**
24
+ * Renewal mode frequency. Use renewal for the current renewal-date behavior, or yearly to create commission work once per year inside policy periods longer than one year.
25
+ * @type {string}
26
+ * @memberof CommissionCreationRenewalConfigDto
27
+ */
28
+ 'frequency': CommissionCreationRenewalConfigDtoFrequencyEnum;
29
+ }
30
+
31
+ export const CommissionCreationRenewalConfigDtoFrequencyEnum = {
32
+ Renewal: 'renewal',
33
+ Yearly: 'yearly'
34
+ } as const;
35
+
36
+ export type CommissionCreationRenewalConfigDtoFrequencyEnum = typeof CommissionCreationRenewalConfigDtoFrequencyEnum[keyof typeof CommissionCreationRenewalConfigDtoFrequencyEnum];
37
+
38
+
@@ -39,7 +39,7 @@ export interface CommissionEstimateClass {
39
39
  */
40
40
  'amount': number;
41
41
  /**
42
- * Type of commission. Valid values: sales, maintenance, other
42
+ * Type of commission. Valid values: sales, maintenance, other, clawback
43
43
  * @type {string}
44
44
  * @memberof CommissionEstimateClass
45
45
  */
@@ -55,7 +55,8 @@ export interface CommissionEstimateClass {
55
55
  export const CommissionEstimateClassTypeEnum = {
56
56
  Sales: 'sales',
57
57
  Maintenance: 'maintenance',
58
- Other: 'other'
58
+ Other: 'other',
59
+ Clawback: 'clawback'
59
60
  } as const;
60
61
 
61
62
  export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];
@@ -0,0 +1,117 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CommissionPaidInvoiceEntryClass
21
+ */
22
+ export interface CommissionPaidInvoiceEntryClass {
23
+ /**
24
+ * The unique database identifier of the paid invoice entry
25
+ * @type {number}
26
+ * @memberof CommissionPaidInvoiceEntryClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Unique identifier for the object.
31
+ * @type {string}
32
+ * @memberof CommissionPaidInvoiceEntryClass
33
+ */
34
+ 'code': string;
35
+ /**
36
+ * Policy whose paid invoice was counted
37
+ * @type {string}
38
+ * @memberof CommissionPaidInvoiceEntryClass
39
+ */
40
+ 'policyCode': string;
41
+ /**
42
+ * Paid invoice counted for invoice-mode commission creation
43
+ * @type {string}
44
+ * @memberof CommissionPaidInvoiceEntryClass
45
+ */
46
+ 'invoiceCode': string;
47
+ /**
48
+ * Commission agreement version used when this invoice was counted
49
+ * @type {string}
50
+ * @memberof CommissionPaidInvoiceEntryClass
51
+ */
52
+ 'commissionAgreementVersionCode': string;
53
+ /**
54
+ * Start of the policy version timeslice matched by the invoice billing interval.
55
+ * @type {string}
56
+ * @memberof CommissionPaidInvoiceEntryClass
57
+ */
58
+ 'policyTimesliceFrom': string;
59
+ /**
60
+ * End of the policy version timeslice matched by the invoice billing interval.
61
+ * @type {string}
62
+ * @memberof CommissionPaidInvoiceEntryClass
63
+ */
64
+ 'policyTimesliceTo': string;
65
+ /**
66
+ * Current paid invoice entry status
67
+ * @type {string}
68
+ * @memberof CommissionPaidInvoiceEntryClass
69
+ */
70
+ 'status': CommissionPaidInvoiceEntryClassStatusEnum;
71
+ /**
72
+ * Candidate created when this entry was reserved for commission creation
73
+ * @type {string}
74
+ * @memberof CommissionPaidInvoiceEntryClass
75
+ */
76
+ 'commissionCandidateCode'?: string;
77
+ /**
78
+ * Commission created from this counted invoice entry
79
+ * @type {string}
80
+ * @memberof CommissionPaidInvoiceEntryClass
81
+ */
82
+ 'commissionCode'?: string;
83
+ /**
84
+ * Time at which the object was created.
85
+ * @type {string}
86
+ * @memberof CommissionPaidInvoiceEntryClass
87
+ */
88
+ 'createdAt': string;
89
+ /**
90
+ * Time at which the object was updated.
91
+ * @type {string}
92
+ * @memberof CommissionPaidInvoiceEntryClass
93
+ */
94
+ 'updatedAt': string;
95
+ /**
96
+ * Identifier of the user who created the record.
97
+ * @type {string}
98
+ * @memberof CommissionPaidInvoiceEntryClass
99
+ */
100
+ 'createdBy': string;
101
+ /**
102
+ * Identifier of the user who last updated the record.
103
+ * @type {string}
104
+ * @memberof CommissionPaidInvoiceEntryClass
105
+ */
106
+ 'updatedBy': string;
107
+ }
108
+
109
+ export const CommissionPaidInvoiceEntryClassStatusEnum = {
110
+ Counted: 'counted',
111
+ Consumed: 'consumed',
112
+ Discarded: 'discarded'
113
+ } as const;
114
+
115
+ export type CommissionPaidInvoiceEntryClassStatusEnum = typeof CommissionPaidInvoiceEntryClassStatusEnum[keyof typeof CommissionPaidInvoiceEntryClassStatusEnum];
116
+
117
+
@@ -14,6 +14,7 @@
14
14
 
15
15
 
16
16
  import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
17
+ import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
17
18
 
18
19
  /**
19
20
  *
@@ -69,6 +70,18 @@ export interface CreateCommissionAgreementRequestDto {
69
70
  * @memberof CreateCommissionAgreementRequestDto
70
71
  */
71
72
  'endDate'?: string;
73
+ /**
74
+ * Date when commission settlement creation should start for this agreement. Treated as a date-only schedule value.
75
+ * @type {string}
76
+ * @memberof CreateCommissionAgreementRequestDto
77
+ */
78
+ 'settlementCreationDate'?: string;
79
+ /**
80
+ * Initial version agreement configuration. Missing values use service defaults.
81
+ * @type {CommissionAgreementVersionConfigDto}
82
+ * @memberof CreateCommissionAgreementRequestDto
83
+ */
84
+ 'config'?: CommissionAgreementVersionConfigDto;
72
85
  }
73
86
 
74
87
  export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
16
17
 
17
18
  /**
18
19
  *
@@ -38,11 +39,23 @@ export interface CreateCommissionAgreementVersionRequestDto {
38
39
  * @memberof CreateCommissionAgreementVersionRequestDto
39
40
  */
40
41
  'endDate'?: string;
42
+ /**
43
+ * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
44
+ * @type {string}
45
+ * @memberof CreateCommissionAgreementVersionRequestDto
46
+ */
47
+ 'settlementCreationDate'?: string;
41
48
  /**
42
49
  * Description explaining what changed in this version or version notes
43
50
  * @type {string}
44
51
  * @memberof CreateCommissionAgreementVersionRequestDto
45
52
  */
46
53
  'versionDescription'?: string;
54
+ /**
55
+ * Version-scoped agreement configuration. Missing values use service defaults.
56
+ * @type {CommissionAgreementVersionConfigDto}
57
+ * @memberof CreateCommissionAgreementVersionRequestDto
58
+ */
59
+ 'config'?: CommissionAgreementVersionConfigDto;
47
60
  }
48
61
 
@@ -39,7 +39,7 @@ export interface CreateCommissionCandidateRequestDto {
39
39
  */
40
40
  'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
41
41
  /**
42
- * The type of commission. Valid values: sales, maintenance, other
42
+ * The type of commission. Valid values: sales, maintenance, other, clawback
43
43
  * @type {string}
44
44
  * @memberof CreateCommissionCandidateRequestDto
45
45
  */
@@ -51,11 +51,23 @@ export interface CreateCommissionCandidateRequestDto {
51
51
  */
52
52
  'commissionCode'?: string;
53
53
  /**
54
- * The date of the next policy renewal for this commission candidate
54
+ * The date of the next policy renewal for this commission candidate. Required when renewal clawback metadata is provided.
55
55
  * @type {string}
56
56
  * @memberof CreateCommissionCandidateRequestDto
57
57
  */
58
58
  'policyRenewalDate'?: string;
59
+ /**
60
+ * Exclusive end of the commission period. If provided, policyRenewalDate and expectedInvoiceEntryCount must also be provided.
61
+ * @type {string}
62
+ * @memberof CreateCommissionCandidateRequestDto
63
+ */
64
+ 'commissionPeriodTo'?: string;
65
+ /**
66
+ * Expected invoice entry count in the commission period. If provided, policyRenewalDate and commissionPeriodTo must also be provided.
67
+ * @type {number}
68
+ * @memberof CreateCommissionCandidateRequestDto
69
+ */
70
+ 'expectedInvoiceEntryCount'?: number;
59
71
  }
60
72
 
61
73
  export const CreateCommissionCandidateRequestDtoCandidateTypeEnum = {
@@ -67,7 +79,8 @@ export type CreateCommissionCandidateRequestDtoCandidateTypeEnum = typeof Create
67
79
  export const CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
68
80
  Sales: 'sales',
69
81
  Maintenance: 'maintenance',
70
- Other: 'other'
82
+ Other: 'other',
83
+ Clawback: 'clawback'
71
84
  } as const;
72
85
 
73
86
  export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface CreateCommissionClawbackRequestDto
21
+ */
22
+ export interface CreateCommissionClawbackRequestDto {
23
+ /**
24
+ * Optional business effective date for the clawback calculation. If omitted, server processing time is used.
25
+ * @type {string}
26
+ * @memberof CreateCommissionClawbackRequestDto
27
+ */
28
+ 'effectiveDate'?: string;
29
+ }
30
+
@@ -0,0 +1,52 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL CommissionService
5
+ * The EMIL CommissionService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ * Contact: kontakt@emil.de
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { CommissionClass } from './commission-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface CreateCommissionClawbackResponseClass
22
+ */
23
+ export interface CreateCommissionClawbackResponseClass {
24
+ /**
25
+ * Whether a new clawback commission was created.
26
+ * @type {boolean}
27
+ * @memberof CreateCommissionClawbackResponseClass
28
+ */
29
+ 'created': boolean;
30
+ /**
31
+ * Reason why no clawback commission was created. Possible reasons: the original commission was not paid out, the calculated clawback amount was zero or positive, or the commission was already fully clawed back.
32
+ * @type {string}
33
+ * @memberof CreateCommissionClawbackResponseClass
34
+ */
35
+ 'notCreatedReason'?: CreateCommissionClawbackResponseClassNotCreatedReasonEnum;
36
+ /**
37
+ * Created clawback commission. Set only when created is true.
38
+ * @type {CommissionClass}
39
+ * @memberof CreateCommissionClawbackResponseClass
40
+ */
41
+ 'commission'?: CommissionClass;
42
+ }
43
+
44
+ export const CreateCommissionClawbackResponseClassNotCreatedReasonEnum = {
45
+ CommissionNotPaidOut: 'commission_not_paid_out',
46
+ ClawbackAmountNotNegative: 'clawback_amount_not_negative',
47
+ CommissionAlreadyFullyClawedBack: 'commission_already_fully_clawed_back'
48
+ } as const;
49
+
50
+ export type CreateCommissionClawbackResponseClassNotCreatedReasonEnum = typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum[keyof typeof CreateCommissionClawbackResponseClassNotCreatedReasonEnum];
51
+
52
+
@@ -39,7 +39,7 @@ export interface CreateCommissionItemRequestDto {
39
39
  */
40
40
  'amount': number;
41
41
  /**
42
- * The type of commission item. Valid values: sales, maintenance, other
42
+ * The type of commission item. Valid values: sales, maintenance, other, clawback
43
43
  * @type {string}
44
44
  * @memberof CreateCommissionItemRequestDto
45
45
  */
@@ -49,7 +49,8 @@ export interface CreateCommissionItemRequestDto {
49
49
  export const CreateCommissionItemRequestDtoTypeEnum = {
50
50
  Sales: 'sales',
51
51
  Maintenance: 'maintenance',
52
- Other: 'other'
52
+ Other: 'other',
53
+ Clawback: 'clawback'
53
54
  } as const;
54
55
 
55
56
  export type CreateCommissionItemRequestDtoTypeEnum = typeof CreateCommissionItemRequestDtoTypeEnum[keyof typeof CreateCommissionItemRequestDtoTypeEnum];
@@ -51,5 +51,11 @@ export interface CreateCommissionRequestDto {
51
51
  * @memberof CreateCommissionRequestDto
52
52
  */
53
53
  'items': Array<CreateCommissionItemRequestDto>;
54
+ /**
55
+ * Commission candidate code linked to this commission.
56
+ * @type {string}
57
+ * @memberof CreateCommissionRequestDto
58
+ */
59
+ 'commissionCandidateCode'?: string;
54
60
  }
55
61
 
@@ -21,7 +21,7 @@
21
21
  */
22
22
  export interface EvaluatedCommissionClass {
23
23
  /**
24
- * Type of commission (e.g., sales, maintenance, other)
24
+ * Type of commission (e.g., sales, maintenance, other, clawback)
25
25
  * @type {string}
26
26
  * @memberof EvaluatedCommissionClass
27
27
  */
@@ -55,7 +55,8 @@ export interface EvaluatedCommissionClass {
55
55
  export const EvaluatedCommissionClassTypeEnum = {
56
56
  Sales: 'sales',
57
57
  Maintenance: 'maintenance',
58
- Other: 'other'
58
+ Other: 'other',
59
+ Clawback: 'clawback'
59
60
  } as const;
60
61
 
61
62
  export type EvaluatedCommissionClassTypeEnum = typeof EvaluatedCommissionClassTypeEnum[keyof typeof EvaluatedCommissionClassTypeEnum];
package/models/index.ts CHANGED
@@ -1,3 +1,5 @@
1
+ export * from './clawback-config-class';
2
+ export * from './clawback-config-dto';
1
3
  export * from './commission-agreement-class';
2
4
  export * from './commission-agreement-metadata-dto';
3
5
  export * from './commission-agreement-metadata-partner-dto';
@@ -6,12 +8,21 @@ export * from './commission-agreement-rule-class';
6
8
  export * from './commission-agreement-rule-config-dto';
7
9
  export * from './commission-agreement-rule-evaluation-class';
8
10
  export * from './commission-agreement-version-class';
11
+ export * from './commission-agreement-version-config-class';
12
+ export * from './commission-agreement-version-config-dto';
9
13
  export * from './commission-candidate-class';
10
14
  export * from './commission-class';
11
15
  export * from './commission-conditions-dto';
12
16
  export * from './commission-config-dto';
17
+ export * from './commission-creation-config-class';
18
+ export * from './commission-creation-config-dto';
19
+ export * from './commission-creation-invoice-config-class';
20
+ export * from './commission-creation-invoice-config-dto';
21
+ export * from './commission-creation-renewal-config-class';
22
+ export * from './commission-creation-renewal-config-dto';
13
23
  export * from './commission-estimate-class';
14
24
  export * from './commission-item-class';
25
+ export * from './commission-paid-invoice-entry-class';
15
26
  export * from './commission-recipient-class';
16
27
  export * from './commission-settlement-class';
17
28
  export * from './create-commission-agreement-product-request-dto';
@@ -24,6 +35,8 @@ export * from './create-commission-agreement-version-request-dto';
24
35
  export * from './create-commission-agreement-version-response-class';
25
36
  export * from './create-commission-candidate-request-dto';
26
37
  export * from './create-commission-candidate-response-class';
38
+ export * from './create-commission-clawback-request-dto';
39
+ export * from './create-commission-clawback-response-class';
27
40
  export * from './create-commission-item-request-dto';
28
41
  export * from './create-commission-recipient-for-products-request-dto';
29
42
  export * from './create-commission-recipient-for-products-response-class';
@@ -54,13 +67,20 @@ export * from './list-commission-agreement-rules-response-class';
54
67
  export * from './list-commission-agreement-versions-response-class';
55
68
  export * from './list-commission-agreements-response-class';
56
69
  export * from './list-commission-candidates-response-class';
70
+ export * from './list-commission-paid-invoice-entries-response-class';
57
71
  export * from './list-commission-recipients-response-class';
58
72
  export * from './list-commission-settlements-response-class';
59
73
  export * from './list-commissions-response-class';
74
+ export * from './list-scheduled-commission-clawback-triggers-response-class';
60
75
  export * from './patch-commission-agreement-status-request-dto';
61
76
  export * from './patch-commission-agreement-status-response-class';
62
77
  export * from './publish-commission-settlements-request-dto';
63
78
  export * from './publish-commission-settlements-response-class';
79
+ export * from './scheduled-commission-clawback-trigger-class';
80
+ export * from './trigger-commission-settlement-creation-request-dto';
81
+ export * from './trigger-commission-settlement-creation-response-class';
82
+ export * from './trigger-due-commission-clawbacks-request-dto';
83
+ export * from './trigger-due-commission-clawbacks-response-class';
64
84
  export * from './update-commission-agreement-product-request-dto';
65
85
  export * from './update-commission-agreement-product-response-class';
66
86
  export * from './update-commission-agreement-request-dto';