@emilgroup/commission-sdk 2.10.1-beta.5 → 2.10.1-beta.51

package/models/commission-candidate-class.ts

@@ -68,6 +68,18 @@ export interface CommissionCandidateClass {
      * @memberof CommissionCandidateClass
      */
     'policyRenewalDate'?: string;
+    /**
+     * Exclusive end of the period the commission will be created for
+     * @type {string}
+     * @memberof CommissionCandidateClass
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period, used as the pro rata denominator
+     * @type {number}
+     * @memberof CommissionCandidateClass
+     */
+    'expectedInvoiceEntryCount'?: number;
     /**
      * Time at which the object was created.
      * @type {string}

package/models/commission-class.ts

@@ -64,6 +64,12 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'commissionAgreementNumber': string;
+    /**
+     * The code of the commission agreement being used for this commission, stable across all of the agreement\'s versions
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionAgreementCode': string;
     /**
      * The unique code or identifier of the partner associated with this commission
      * @type {string}
@@ -100,12 +106,54 @@ export interface CommissionClass {
      * @memberof CommissionClass
      */
     'status': string;
+    /**
+     * The latest date when the commission became open.
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'openedAt'?: string;
     /**
      * The code of the settlement this commission is associated with
      * @type {string}
      * @memberof CommissionClass
      */
     'settlementCode'?: string;
+    /**
+     * Start of the period the commission was originally created for
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionPeriodFrom'?: string;
+    /**
+     * Exclusive end of the period the commission was originally created for
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period, used as the pro rata denominator
+     * @type {number}
+     * @memberof CommissionClass
+     */
+    'expectedInvoiceEntryCount'?: number;
+    /**
+     * For clawback commissions, the original commission being clawed back
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'originalCommissionCode'?: string;
+    /**
+     * The trigger type that created this clawback commission
+     * @type {string}
+     * @memberof CommissionClass
+     */
+    'clawbackTriggerType'?: CommissionClassClawbackTriggerTypeEnum;
+    /**
+     * Whether the commission was created manually through the REST API rather than by the system. Manual commissions are clawed back in full, system commissions are clawed back using pro rata
+     * @type {boolean}
+     * @memberof CommissionClass
+     */
+    'manual': boolean;
     /**
      * Time at which the object was created.
      * @type {string}
@@ -138,3 +186,14 @@ export interface CommissionClass {
     'items': Array<CommissionItemClass>;
 }
 
+export const CommissionClassClawbackTriggerTypeEnum = {
+    Manual: 'manual',
+    PolicyTermination: 'policy_termination',
+    PolicyWithdrawal: 'policy_withdrawal',
+    IntermediarySwitched: 'intermediary_switched',
+    InvoiceReopened: 'invoice_reopened'
+} as const;
+
+export type CommissionClassClawbackTriggerTypeEnum = typeof CommissionClassClawbackTriggerTypeEnum[keyof typeof CommissionClassClawbackTriggerTypeEnum];
+
+

package/models/commission-config-dto.ts

@@ -22,7 +22,7 @@ import { CommissionConditionsDto } from './commission-conditions-dto';
  */
 export interface CommissionConfigDto {
     /**
-     * Type of commission (e.g., sales, maintenance, other)
+     * Type of commission (e.g., sales, maintenance, other, clawback)
      * @type {string}
      * @memberof CommissionConfigDto
      */
@@ -50,7 +50,8 @@ export interface CommissionConfigDto {
 export const CommissionConfigDtoTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type CommissionConfigDtoTypeEnum = typeof CommissionConfigDtoTypeEnum[keyof typeof CommissionConfigDtoTypeEnum];

package/models/commission-creation-config-class.ts

@@ -0,0 +1,52 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CommissionCreationInvoiceConfigClass } from './commission-creation-invoice-config-class';
+import { CommissionCreationRenewalConfigClass } from './commission-creation-renewal-config-class';
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationConfigClass
+ */
+export interface CommissionCreationConfigClass {
+    /**
+     * Determines which event drives recurring commission creation: renewal dates or paid invoices.
+     * @type {string}
+     * @memberof CommissionCreationConfigClass
+     */
+    'mode': CommissionCreationConfigClassModeEnum;
+    /**
+     * Required when mode is renewal.      Defines whether commission work is created only at renewal or yearly inside long policy periods.
+     * @type {CommissionCreationRenewalConfigClass}
+     * @memberof CommissionCreationConfigClass
+     */
+    'renewal'?: CommissionCreationRenewalConfigClass;
+    /**
+     * Required when mode is invoice.     Defines how many paid invoices must be counted before commission work is created.
+     * @type {CommissionCreationInvoiceConfigClass}
+     * @memberof CommissionCreationConfigClass
+     */
+    'invoice'?: CommissionCreationInvoiceConfigClass;
+}
+
+export const CommissionCreationConfigClassModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+} as const;
+
+export type CommissionCreationConfigClassModeEnum = typeof CommissionCreationConfigClassModeEnum[keyof typeof CommissionCreationConfigClassModeEnum];
+
+

package/models/commission-creation-config-dto.ts

@@ -0,0 +1,52 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+import { CommissionCreationInvoiceConfigDto } from './commission-creation-invoice-config-dto';
+import { CommissionCreationRenewalConfigDto } from './commission-creation-renewal-config-dto';
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationConfigDto
+ */
+export interface CommissionCreationConfigDto {
+    /**
+     * Determines which event drives recurring commission creation: renewal dates or paid invoices.
+     * @type {string}
+     * @memberof CommissionCreationConfigDto
+     */
+    'mode': CommissionCreationConfigDtoModeEnum;
+    /**
+     * Required when mode is renewal.      Defines whether commission work is created only at renewal or yearly inside long policy periods.
+     * @type {CommissionCreationRenewalConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'renewal'?: CommissionCreationRenewalConfigDto;
+    /**
+     * Required when mode is invoice.     Defines how many paid invoices must be counted before commission work is created.
+     * @type {CommissionCreationInvoiceConfigDto}
+     * @memberof CommissionCreationConfigDto
+     */
+    'invoice'?: CommissionCreationInvoiceConfigDto;
+}
+
+export const CommissionCreationConfigDtoModeEnum = {
+    Renewal: 'renewal',
+    Invoice: 'invoice'
+} as const;
+
+export type CommissionCreationConfigDtoModeEnum = typeof CommissionCreationConfigDtoModeEnum[keyof typeof CommissionCreationConfigDtoModeEnum];
+
+

package/models/commission-creation-invoice-config-class.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationInvoiceConfigClass
+ */
+export interface CommissionCreationInvoiceConfigClass {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigClass
+     */
+    'paidInvoiceInterval': number;
+}
+

package/models/commission-creation-invoice-config-dto.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationInvoiceConfigDto
+ */
+export interface CommissionCreationInvoiceConfigDto {
+    /**
+     * Number of paid invoices required before commission work is created. Use 1 for every paid invoice.
+     * @type {number}
+     * @memberof CommissionCreationInvoiceConfigDto
+     */
+    'paidInvoiceInterval': number;
+}
+

package/models/commission-creation-renewal-config-class.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationRenewalConfigClass
+ */
+export interface CommissionCreationRenewalConfigClass {
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigClass
+     */
+    'frequency': CommissionCreationRenewalConfigClassFrequencyEnum;
+}
+
+export const CommissionCreationRenewalConfigClassFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionCreationRenewalConfigClassFrequencyEnum = typeof CommissionCreationRenewalConfigClassFrequencyEnum[keyof typeof CommissionCreationRenewalConfigClassFrequencyEnum];
+
+

package/models/commission-creation-renewal-config-dto.ts

@@ -0,0 +1,38 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionCreationRenewalConfigDto
+ */
+export interface CommissionCreationRenewalConfigDto {
+    /**
+     * 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.
+     * @type {string}
+     * @memberof CommissionCreationRenewalConfigDto
+     */
+    'frequency': CommissionCreationRenewalConfigDtoFrequencyEnum;
+}
+
+export const CommissionCreationRenewalConfigDtoFrequencyEnum = {
+    Renewal: 'renewal',
+    Yearly: 'yearly'
+} as const;
+
+export type CommissionCreationRenewalConfigDtoFrequencyEnum = typeof CommissionCreationRenewalConfigDtoFrequencyEnum[keyof typeof CommissionCreationRenewalConfigDtoFrequencyEnum];
+
+

package/models/commission-estimate-class.ts

@@ -39,7 +39,7 @@ export interface CommissionEstimateClass {
      */
     'amount': number;
     /**
-     * Type of commission. Valid values: sales, maintenance, other
+     * Type of commission. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof CommissionEstimateClass
      */
@@ -55,7 +55,8 @@ export interface CommissionEstimateClass {
 export const CommissionEstimateClassTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type CommissionEstimateClassTypeEnum = typeof CommissionEstimateClassTypeEnum[keyof typeof CommissionEstimateClassTypeEnum];

package/models/commission-paid-invoice-entry-class.ts

@@ -0,0 +1,124 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CommissionPaidInvoiceEntryClass
+ */
+export interface CommissionPaidInvoiceEntryClass {
+    /**
+     * The unique database identifier of the paid invoice entry
+     * @type {number}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'id': number;
+    /**
+     * Unique identifier for the object.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'code': string;
+    /**
+     * Policy whose paid invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyCode': string;
+    /**
+     * Paid invoice counted for invoice-mode commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'invoiceCode': string;
+    /**
+     * Commission agreement version used when this invoice was counted
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionAgreementVersionCode': string;
+    /**
+     * Start of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceFrom': string;
+    /**
+     * End of the policy version timeslice matched by the invoice billing interval.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'policyTimesliceTo': string;
+    /**
+     * The status of the paid invoice entry. Valid values: counted, consumed, settled_no_commission, discarded
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'status': CommissionPaidInvoiceEntryClassStatusEnum;
+    /**
+     * Whether this entry advances the interval counter. False for a premium correction, which is paid out with the group that closes after it.
+     * @type {boolean}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'countsTowardInterval': boolean;
+    /**
+     * Candidate created when this entry was reserved for commission creation
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCandidateCode'?: string;
+    /**
+     * Commission created from this counted invoice entry
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'commissionCode'?: string;
+    /**
+     * Time at which the object was created.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdAt': string;
+    /**
+     * Time at which the object was updated.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedAt': string;
+    /**
+     * Identifier of the user who created the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'createdBy': string;
+    /**
+     * Identifier of the user who last updated the record.
+     * @type {string}
+     * @memberof CommissionPaidInvoiceEntryClass
+     */
+    'updatedBy': string;
+}
+
+export const CommissionPaidInvoiceEntryClassStatusEnum = {
+    Counted: 'counted',
+    Consumed: 'consumed',
+    SettledNoCommission: 'settled_no_commission',
+    Discarded: 'discarded'
+} as const;
+
+export type CommissionPaidInvoiceEntryClassStatusEnum = typeof CommissionPaidInvoiceEntryClassStatusEnum[keyof typeof CommissionPaidInvoiceEntryClassStatusEnum];
+
+

package/models/create-commission-agreement-request-dto.ts

@@ -14,6 +14,7 @@
 
 
 import { CommissionAgreementMetadataDto } from './commission-agreement-metadata-dto';
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -69,6 +70,18 @@ export interface CreateCommissionAgreementRequestDto {
      * @memberof CreateCommissionAgreementRequestDto
      */
     'endDate'?: string;
+    /**
+     * Date when commission settlement creation should start for this agreement. Treated as a date-only schedule value.
+     * @type {string}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'settlementCreationDate'?: string;
+    /**
+     * Initial version agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
+     * @memberof CreateCommissionAgreementRequestDto
+     */
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 
 export const CreateCommissionAgreementRequestDtoBillingFrequencyEnum = {

package/models/create-commission-agreement-version-request-dto.ts

@@ -13,6 +13,7 @@
  */
 
 
+import { CommissionAgreementVersionConfigDto } from './commission-agreement-version-config-dto';
 
 /**
  * 
@@ -38,11 +39,23 @@ export interface CreateCommissionAgreementVersionRequestDto {
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
     'endDate'?: string;
+    /**
+     * Date when commission settlement creation should start for this agreement version. Treated as a date-only schedule value.
+     * @type {string}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'settlementCreationDate'?: string;
     /**
      * Description explaining what changed in this version or version notes
      * @type {string}
      * @memberof CreateCommissionAgreementVersionRequestDto
      */
     'versionDescription'?: string;
+    /**
+     * Version-scoped agreement configuration. Missing values use service defaults.
+     * @type {CommissionAgreementVersionConfigDto}
+     * @memberof CreateCommissionAgreementVersionRequestDto
+     */
+    'config'?: CommissionAgreementVersionConfigDto;
 }
 

package/models/create-commission-candidate-request-dto.ts

@@ -39,7 +39,7 @@ export interface CreateCommissionCandidateRequestDto {
      */
     'candidateType': CreateCommissionCandidateRequestDtoCandidateTypeEnum;
     /**
-     * The type of commission. Valid values: sales, maintenance, other
+     * The type of commission. Valid values: sales, maintenance, other, clawback
      * @type {string}
      * @memberof CreateCommissionCandidateRequestDto
      */
@@ -51,11 +51,23 @@ export interface CreateCommissionCandidateRequestDto {
      */
     'commissionCode'?: string;
     /**
-     * The date of the next policy renewal for this commission candidate
+     * The date of the next policy renewal for this commission candidate. Required when renewal clawback metadata is provided.
      * @type {string}
      * @memberof CreateCommissionCandidateRequestDto
      */
     'policyRenewalDate'?: string;
+    /**
+     * Exclusive end of the commission period. If provided, policyRenewalDate and expectedInvoiceEntryCount must also be provided.
+     * @type {string}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'commissionPeriodTo'?: string;
+    /**
+     * Expected invoice entry count in the commission period. If provided, policyRenewalDate and commissionPeriodTo must also be provided.
+     * @type {number}
+     * @memberof CreateCommissionCandidateRequestDto
+     */
+    'expectedInvoiceEntryCount'?: number;
 }
 
 export const CreateCommissionCandidateRequestDtoCandidateTypeEnum = {
@@ -67,7 +79,8 @@ export type CreateCommissionCandidateRequestDtoCandidateTypeEnum = typeof Create
 export const CreateCommissionCandidateRequestDtoCommissionTypeEnum = {
     Sales: 'sales',
     Maintenance: 'maintenance',
-    Other: 'other'
+    Other: 'other',
+    Clawback: 'clawback'
 } as const;
 
 export type CreateCommissionCandidateRequestDtoCommissionTypeEnum = typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum[keyof typeof CreateCommissionCandidateRequestDtoCommissionTypeEnum];

package/models/create-commission-clawback-request-dto.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * EMIL CommissionService
+ * The EMIL CommissionService API description
+ *
+ * The version of the OpenAPI document: 1.0
+ * Contact: kontakt@emil.de
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+
+
+/**
+ * 
+ * @export
+ * @interface CreateCommissionClawbackRequestDto
+ */
+export interface CreateCommissionClawbackRequestDto {
+    /**
+     * Optional business effective date for the clawback calculation. If omitted, server processing time is used.
+     * @type {string}
+     * @memberof CreateCommissionClawbackRequestDto
+     */
+    'effectiveDate'?: string;
+}
+