@trii/types 2.10.656 → 2.10.657

package/dist/Collections/Api.d.ts

@@ -0,0 +1,41 @@
+import { IDebt } from './Debt';
+import { CollectionPropertyValue, DebtOrigin, DebtPriority, DebtStage } from './Common';
+export interface IDebtFilter {
+    search?: string;
+    stages?: DebtStage[];
+    statusIds?: string[];
+    priorities?: DebtPriority[];
+    origins?: DebtOrigin[];
+    contactIds?: string[];
+    creditorIds?: string[];
+    portfolioIds?: string[];
+    batchIds?: string[];
+    assigneeIds?: string[];
+    dueFrom?: Date;
+    dueTo?: Date;
+    minimumDaysPastDue?: number;
+    fields?: {
+        fieldNameKey: string;
+        operator: string;
+        value?: CollectionPropertyValue;
+    }[];
+}
+export interface IDebtQuery {
+    cursor?: string;
+    limit?: number;
+    filter?: IDebtFilter;
+    sort?: {
+        fieldNameKey: string;
+        direction: 'ASC' | 'DESC';
+    }[];
+}
+export interface IDebtPage {
+    items: IDebt[];
+    nextCursor?: string;
+    hasMore: boolean;
+}
+export interface ITransitionDebtDto {
+    expectedVersion: number;
+    toStatusId: string;
+    comment?: string;
+}

package/dist/Collections/Api.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/Collections/Commission.d.ts

@@ -0,0 +1,52 @@
+import { CollectionConditionOperator, CollectionPropertyValue, ICollectionAuditedEntity, ICollectionMoney } from './Common';
+export declare enum CommissionBaseType {
+    TOTAL_COLLECTED = "TOTAL_COLLECTED",
+    PRINCIPAL_COLLECTED = "PRINCIPAL_COLLECTED",
+    INTEREST_COLLECTED = "INTEREST_COLLECTED",
+    FEES_COLLECTED = "FEES_COLLECTED"
+}
+export interface ICommissionCondition {
+    fieldNameKey: string;
+    operator: CollectionConditionOperator;
+    expectedValue?: CollectionPropertyValue;
+}
+export interface ICommissionTier {
+    id: string;
+    minimum?: ICollectionMoney;
+    maximum?: ICollectionMoney;
+    percentage: string;
+}
+export interface ICommissionRule extends ICollectionAuditedEntity {
+    ruleSetId: string;
+    name: string;
+    enabled: boolean;
+    order: number;
+    baseType: CommissionBaseType;
+    fixedPercentage?: string;
+    tiers?: ICommissionTier[];
+    conditions?: ICommissionCondition[];
+    validFrom?: Date;
+    validTo?: Date;
+}
+export interface ICommissionRuleSet extends ICollectionAuditedEntity {
+    portfolioId: string;
+    name: string;
+    enabled: boolean;
+    ruleIds: string[];
+}
+export interface IAgentCommissionResult {
+    id: string;
+    spaceId: string;
+    portfolioId: string;
+    paymentId: string;
+    userId: string;
+    ruleId: string;
+    ruleSnapshot?: string;
+    commissionBase: ICollectionMoney;
+    percentage: string;
+    commissionAmount: ICollectionMoney;
+    calculatedAt: Date;
+    adjustedAt?: Date;
+    adjustedBy?: string;
+    adjustmentReason?: string;
+}

package/dist/Collections/Commission.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CommissionBaseType = void 0;
+var CommissionBaseType;
+(function (CommissionBaseType) {
+    CommissionBaseType["TOTAL_COLLECTED"] = "TOTAL_COLLECTED";
+    CommissionBaseType["PRINCIPAL_COLLECTED"] = "PRINCIPAL_COLLECTED";
+    CommissionBaseType["INTEREST_COLLECTED"] = "INTEREST_COLLECTED";
+    CommissionBaseType["FEES_COLLECTED"] = "FEES_COLLECTED";
+})(CommissionBaseType || (exports.CommissionBaseType = CommissionBaseType = {}));

package/dist/Collections/Common.d.ts

@@ -0,0 +1,78 @@
+import { IContactInfo } from '../Contacts/contacts';
+export interface ICollectionMoney {
+    amount: string;
+    currency: string;
+}
+export interface ICollectionAuditedEntity {
+    id: string;
+    spaceId: string;
+    createdAt: Date;
+    createdBy: string;
+    updatedAt?: Date;
+    updatedBy?: string;
+    deletedAt?: Date;
+    deletedBy?: string;
+}
+export declare enum DebtStage {
+    OPEN = "OPEN",
+    IN_NEGOTIATION = "IN_NEGOTIATION",
+    PAYMENT_PLAN = "PAYMENT_PLAN",
+    SETTLED = "SETTLED",
+    UNCOLLECTIBLE = "UNCOLLECTIBLE",
+    CANCELLED = "CANCELLED"
+}
+export declare enum DebtPriority {
+    LOW = "LOW",
+    MEDIUM = "MEDIUM",
+    HIGH = "HIGH",
+    URGENT = "URGENT"
+}
+export declare enum DebtOrigin {
+    IMPORT = "IMPORT",
+    API = "API",
+    MANUAL = "MANUAL",
+    AUTOMATION = "AUTOMATION"
+}
+export interface IDebtStatus extends ICollectionAuditedEntity {
+    name: string;
+    description?: string;
+    color?: string;
+    order: number;
+    stage: DebtStage;
+    isInitial: boolean;
+    isFinal: boolean;
+    enabled: boolean;
+}
+export type CollectionPropertyValue = string | number | boolean | Date | null | CollectionPropertyValue[] | {
+    [key: string]: CollectionPropertyValue;
+};
+export interface IDebtProperty {
+    nameKey: string;
+    value: CollectionPropertyValue;
+}
+export declare enum CollectionConditionOperator {
+    EQUALS = "EQUALS",
+    NOT_EQUALS = "NOT_EQUALS",
+    EXISTS = "EXISTS",
+    NOT_EXISTS = "NOT_EXISTS",
+    GREATER_THAN = "GREATER_THAN",
+    GREATER_THAN_OR_EQUAL = "GREATER_THAN_OR_EQUAL",
+    LESS_THAN = "LESS_THAN",
+    LESS_THAN_OR_EQUAL = "LESS_THAN_OR_EQUAL",
+    IN = "IN",
+    NOT_IN = "NOT_IN"
+}
+export interface ICollectionDateRange {
+    from: Date;
+    to: Date;
+}
+export interface ICollectionMetricPoint {
+    date: Date;
+    value: number;
+}
+export interface ICollectionMetricGroup {
+    key: string;
+    label: string;
+    value: number;
+}
+export type IDebtContactProjection = IContactInfo;

package/dist/Collections/Common.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CollectionConditionOperator = exports.DebtOrigin = exports.DebtPriority = exports.DebtStage = void 0;
+var DebtStage;
+(function (DebtStage) {
+    DebtStage["OPEN"] = "OPEN";
+    DebtStage["IN_NEGOTIATION"] = "IN_NEGOTIATION";
+    DebtStage["PAYMENT_PLAN"] = "PAYMENT_PLAN";
+    DebtStage["SETTLED"] = "SETTLED";
+    DebtStage["UNCOLLECTIBLE"] = "UNCOLLECTIBLE";
+    DebtStage["CANCELLED"] = "CANCELLED";
+})(DebtStage || (exports.DebtStage = DebtStage = {}));
+var DebtPriority;
+(function (DebtPriority) {
+    DebtPriority["LOW"] = "LOW";
+    DebtPriority["MEDIUM"] = "MEDIUM";
+    DebtPriority["HIGH"] = "HIGH";
+    DebtPriority["URGENT"] = "URGENT";
+})(DebtPriority || (exports.DebtPriority = DebtPriority = {}));
+var DebtOrigin;
+(function (DebtOrigin) {
+    DebtOrigin["IMPORT"] = "IMPORT";
+    DebtOrigin["API"] = "API";
+    DebtOrigin["MANUAL"] = "MANUAL";
+    DebtOrigin["AUTOMATION"] = "AUTOMATION";
+})(DebtOrigin || (exports.DebtOrigin = DebtOrigin = {}));
+var CollectionConditionOperator;
+(function (CollectionConditionOperator) {
+    CollectionConditionOperator["EQUALS"] = "EQUALS";
+    CollectionConditionOperator["NOT_EQUALS"] = "NOT_EQUALS";
+    CollectionConditionOperator["EXISTS"] = "EXISTS";
+    CollectionConditionOperator["NOT_EXISTS"] = "NOT_EXISTS";
+    CollectionConditionOperator["GREATER_THAN"] = "GREATER_THAN";
+    CollectionConditionOperator["GREATER_THAN_OR_EQUAL"] = "GREATER_THAN_OR_EQUAL";
+    CollectionConditionOperator["LESS_THAN"] = "LESS_THAN";
+    CollectionConditionOperator["LESS_THAN_OR_EQUAL"] = "LESS_THAN_OR_EQUAL";
+    CollectionConditionOperator["IN"] = "IN";
+    CollectionConditionOperator["NOT_IN"] = "NOT_IN";
+})(CollectionConditionOperator || (exports.CollectionConditionOperator = CollectionConditionOperator = {}));

package/dist/Collections/Dashboard.d.ts

@@ -0,0 +1,27 @@
+import { ICollectionDateRange, ICollectionMoney, ICollectionMetricGroup, ICollectionMetricPoint } from './Common';
+export interface ICollectionsDashboardFilter {
+    range: ICollectionDateRange;
+    creditorIds?: string[];
+    portfolioIds?: string[];
+    batchIds?: string[];
+    statusIds?: string[];
+    assigneeIds?: string[];
+    assignedGroupIds?: string[];
+}
+export interface ICollectionsDashboardMetrics {
+    range: ICollectionDateRange;
+    totalAssigned: ICollectionMoney;
+    outstandingBalance: ICollectionMoney;
+    collected: ICollectionMoney;
+    recoveryPercentage: number;
+    activePaymentPlans: number;
+    failedPaymentPlans: number;
+    pendingPromises: number;
+    brokenPromises: number;
+    generatedCommissions: ICollectionMoney;
+    collectedSeries: ICollectionMetricPoint[];
+    byPortfolio: ICollectionMetricGroup[];
+    byAgent: ICollectionMetricGroup[];
+    byStatus: ICollectionMetricGroup[];
+    byDaysPastDueRange: ICollectionMetricGroup[];
+}

package/dist/Collections/Dashboard.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/Collections/Debt.d.ts

@@ -0,0 +1,97 @@
+import { ICollectionMoney, IDebtContactProjection, IDebtProperty, DebtOrigin, DebtPriority, DebtStage } from './Common';
+export declare enum DebtProductType {
+    LOAN = "LOAN",
+    CREDIT_CARD = "CREDIT_CARD",
+    ACCOUNT = "ACCOUNT",
+    SERVICE = "SERVICE",
+    INVOICE = "INVOICE",
+    OTHER = "OTHER"
+}
+export interface IDebtBalanceBreakdown {
+    principal: ICollectionMoney;
+    compensatoryInterest?: ICollectionMoney;
+    penaltyInterest?: ICollectionMoney;
+    fees?: ICollectionMoney;
+    taxes?: ICollectionMoney;
+    discounts?: ICollectionMoney;
+    total: ICollectionMoney;
+}
+export interface IDebt {
+    id: string;
+    spaceId: string;
+    number: number;
+    title: string;
+    description?: string;
+    contactId: string;
+    contact?: IDebtContactProjection;
+    statusId: string;
+    stage: DebtStage;
+    priority: DebtPriority;
+    origin: DebtOrigin;
+    assigneeId?: string;
+    assignedGroupId?: string;
+    properties: IDebtProperty[];
+    version: number;
+    creditorId: string;
+    portfolioId: string;
+    batchId?: string;
+    productType: DebtProductType;
+    productName?: string;
+    productReference?: string;
+    originalAmount: ICollectionMoney;
+    currentBalance: ICollectionMoney;
+    balanceBreakdown?: IDebtBalanceBreakdown;
+    originatedAt?: Date;
+    dueAt: Date;
+    daysPastDue: number;
+    interestConfigurationId?: string;
+    activePaymentPlanId?: string;
+    sourceRowExternalId?: string;
+    createdAt: Date;
+    createdBy: string;
+    updatedAt?: Date;
+    updatedBy?: string;
+    deletedAt?: Date;
+    deletedBy?: string;
+}
+export interface ICreateDebtDto {
+    title: string;
+    description?: string;
+    contactId: string;
+    statusId?: string;
+    priority: DebtPriority;
+    origin: DebtOrigin;
+    assigneeId?: string;
+    assignedGroupId?: string;
+    properties?: IDebtProperty[];
+    source?: string;
+    idempotencyKey?: string;
+    creditorId: string;
+    portfolioId: string;
+    batchId?: string;
+    productType: DebtProductType;
+    productName?: string;
+    productReference?: string;
+    originalAmount: ICollectionMoney;
+    currentBalance?: ICollectionMoney;
+    balanceBreakdown?: IDebtBalanceBreakdown;
+    originatedAt?: Date;
+    dueAt: Date;
+    sourceRowExternalId?: string;
+}
+export interface IUpdateDebtDto {
+    expectedVersion: number;
+    title?: string;
+    description?: string;
+    priority?: DebtPriority;
+    assigneeId?: string;
+    assignedGroupId?: string;
+    properties?: IDebtProperty[];
+    productType?: DebtProductType;
+    productName?: string;
+    productReference?: string;
+    currentBalance?: ICollectionMoney;
+    balanceBreakdown?: IDebtBalanceBreakdown;
+    dueAt?: Date;
+    interestConfigurationId?: string;
+}

package/dist/Collections/Debt.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebtProductType = void 0;
+var DebtProductType;
+(function (DebtProductType) {
+    DebtProductType["LOAN"] = "LOAN";
+    DebtProductType["CREDIT_CARD"] = "CREDIT_CARD";
+    DebtProductType["ACCOUNT"] = "ACCOUNT";
+    DebtProductType["SERVICE"] = "SERVICE";
+    DebtProductType["INVOICE"] = "INVOICE";
+    DebtProductType["OTHER"] = "OTHER";
+})(DebtProductType || (exports.DebtProductType = DebtProductType = {}));

package/dist/Collections/Interest.d.ts

@@ -0,0 +1,38 @@
+import { ICollectionAuditedEntity } from './Common';
+export declare enum InterestType {
+    COMPENSATORY = "COMPENSATORY",
+    PENALTY = "PENALTY"
+}
+export declare enum InterestCalculationMethod {
+    SIMPLE = "SIMPLE",
+    COMPOUND = "COMPOUND"
+}
+export declare enum InterestRatePeriod {
+    DAILY = "DAILY",
+    MONTHLY = "MONTHLY",
+    ANNUAL = "ANNUAL"
+}
+export declare enum InterestDayCountBasis {
+    ACTUAL_365 = "ACTUAL_365",
+    ACTUAL_360 = "ACTUAL_360",
+    THIRTY_360 = "THIRTY_360"
+}
+export interface IInterestRatePeriod {
+    rate: string;
+    period: InterestRatePeriod;
+    validFrom: Date;
+    validTo?: Date;
+}
+export interface IInterestComponentConfiguration {
+    type: InterestType;
+    method: InterestCalculationMethod;
+    dayCountBasis: InterestDayCountBasis;
+    capitalizationEnabled: boolean;
+    rates: IInterestRatePeriod[];
+}
+export interface IInterestConfiguration extends ICollectionAuditedEntity {
+    name: string;
+    description?: string;
+    enabled: boolean;
+    components: IInterestComponentConfiguration[];
+}

package/dist/Collections/Interest.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InterestDayCountBasis = exports.InterestRatePeriod = exports.InterestCalculationMethod = exports.InterestType = void 0;
+var InterestType;
+(function (InterestType) {
+    InterestType["COMPENSATORY"] = "COMPENSATORY";
+    InterestType["PENALTY"] = "PENALTY";
+})(InterestType || (exports.InterestType = InterestType = {}));
+var InterestCalculationMethod;
+(function (InterestCalculationMethod) {
+    InterestCalculationMethod["SIMPLE"] = "SIMPLE";
+    InterestCalculationMethod["COMPOUND"] = "COMPOUND";
+})(InterestCalculationMethod || (exports.InterestCalculationMethod = InterestCalculationMethod = {}));
+var InterestRatePeriod;
+(function (InterestRatePeriod) {
+    InterestRatePeriod["DAILY"] = "DAILY";
+    InterestRatePeriod["MONTHLY"] = "MONTHLY";
+    InterestRatePeriod["ANNUAL"] = "ANNUAL";
+})(InterestRatePeriod || (exports.InterestRatePeriod = InterestRatePeriod = {}));
+var InterestDayCountBasis;
+(function (InterestDayCountBasis) {
+    InterestDayCountBasis["ACTUAL_365"] = "ACTUAL_365";
+    InterestDayCountBasis["ACTUAL_360"] = "ACTUAL_360";
+    InterestDayCountBasis["THIRTY_360"] = "THIRTY_360";
+})(InterestDayCountBasis || (exports.InterestDayCountBasis = InterestDayCountBasis = {}));

package/dist/Collections/Payment.d.ts

@@ -0,0 +1,87 @@
+import { ICollectionMoney } from './Common';
+export declare enum DebtPaymentStatus {
+    PENDING = "PENDING",
+    CONFIRMED = "CONFIRMED",
+    REJECTED = "REJECTED",
+    REVERSED = "REVERSED"
+}
+export declare enum DebtPaymentMethod {
+    CASH = "CASH",
+    BANK_TRANSFER = "BANK_TRANSFER",
+    CREDIT_CARD = "CREDIT_CARD",
+    DEBIT_CARD = "DEBIT_CARD",
+    DIRECT_DEBIT = "DIRECT_DEBIT",
+    DIGITAL_WALLET = "DIGITAL_WALLET",
+    CHECK = "CHECK",
+    OTHER = "OTHER"
+}
+export interface IPaymentAllocation {
+    debtId: string;
+    installmentId?: string;
+    principal: ICollectionMoney;
+    compensatoryInterest?: ICollectionMoney;
+    penaltyInterest?: ICollectionMoney;
+    fees?: ICollectionMoney;
+    taxes?: ICollectionMoney;
+    discounts?: ICollectionMoney;
+    total: ICollectionMoney;
+}
+export interface IPaymentAgentAttribution {
+    userId: string;
+    percentage: string;
+    amount?: ICollectionMoney;
+    commissionRuleId?: string;
+    adjustedBy?: string;
+    adjustedAt?: Date;
+    adjustmentReason?: string;
+}
+export interface IDebtPayment {
+    id: string;
+    spaceId: string;
+    portfolioId: string;
+    contactId: string;
+    paymentPlanId?: string;
+    amount: ICollectionMoney;
+    paidAt: Date;
+    method: DebtPaymentMethod;
+    status: DebtPaymentStatus;
+    reference?: string;
+    allocations: IPaymentAllocation[];
+    agentAttributions: IPaymentAgentAttribution[];
+    externalReferences?: {
+        system: string;
+        externalId: string;
+    }[];
+    source?: string;
+    idempotencyKey?: string;
+    confirmedAt?: Date;
+    confirmedBy?: string;
+    createdAt: Date;
+    createdBy: string;
+    reversedByPaymentReversalId?: string;
+}
+export interface IDebtPaymentReversal {
+    id: string;
+    spaceId: string;
+    paymentId: string;
+    amount: ICollectionMoney;
+    reason: string;
+    allocations: IPaymentAllocation[];
+    reversedAt: Date;
+    reversedBy: string;
+    source?: string;
+    idempotencyKey?: string;
+}
+export interface ICreateDebtPaymentDto {
+    portfolioId: string;
+    contactId: string;
+    paymentPlanId?: string;
+    amount: ICollectionMoney;
+    paidAt: Date;
+    method: DebtPaymentMethod;
+    reference?: string;
+    allocations: IPaymentAllocation[];
+    agentAttributions: IPaymentAgentAttribution[];
+    source?: string;
+    idempotencyKey?: string;
+}

package/dist/Collections/Payment.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DebtPaymentMethod = exports.DebtPaymentStatus = void 0;
+var DebtPaymentStatus;
+(function (DebtPaymentStatus) {
+    DebtPaymentStatus["PENDING"] = "PENDING";
+    DebtPaymentStatus["CONFIRMED"] = "CONFIRMED";
+    DebtPaymentStatus["REJECTED"] = "REJECTED";
+    DebtPaymentStatus["REVERSED"] = "REVERSED";
+})(DebtPaymentStatus || (exports.DebtPaymentStatus = DebtPaymentStatus = {}));
+var DebtPaymentMethod;
+(function (DebtPaymentMethod) {
+    DebtPaymentMethod["CASH"] = "CASH";
+    DebtPaymentMethod["BANK_TRANSFER"] = "BANK_TRANSFER";
+    DebtPaymentMethod["CREDIT_CARD"] = "CREDIT_CARD";
+    DebtPaymentMethod["DEBIT_CARD"] = "DEBIT_CARD";
+    DebtPaymentMethod["DIRECT_DEBIT"] = "DIRECT_DEBIT";
+    DebtPaymentMethod["DIGITAL_WALLET"] = "DIGITAL_WALLET";
+    DebtPaymentMethod["CHECK"] = "CHECK";
+    DebtPaymentMethod["OTHER"] = "OTHER";
+})(DebtPaymentMethod || (exports.DebtPaymentMethod = DebtPaymentMethod = {}));

package/dist/Collections/PaymentPlan.d.ts

@@ -0,0 +1,87 @@
+import { ICollectionAuditedEntity, ICollectionMoney } from './Common';
+import { IPaymentPlanConfigurationSnapshot, PaymentPlanFrequency } from './PaymentPlanConfiguration';
+export declare enum PaymentPlanStatus {
+    DRAFT = "DRAFT",
+    PENDING_APPROVAL = "PENDING_APPROVAL",
+    ACTIVE = "ACTIVE",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    CANCELLED = "CANCELLED",
+    REFINANCED = "REFINANCED"
+}
+export declare enum PaymentPlanInstallmentStatus {
+    PENDING = "PENDING",
+    PARTIALLY_PAID = "PARTIALLY_PAID",
+    PAID = "PAID",
+    OVERDUE = "OVERDUE",
+    CANCELLED = "CANCELLED"
+}
+export interface IPlannedDebtAllocation {
+    debtId: string;
+    principal: ICollectionMoney;
+    interest?: ICollectionMoney;
+    fees?: ICollectionMoney;
+    taxes?: ICollectionMoney;
+    discounts?: ICollectionMoney;
+    total: ICollectionMoney;
+}
+export interface IPaymentPlanInstallment {
+    id: string;
+    number: number;
+    dueAt: Date;
+    amount: ICollectionMoney;
+    paidAmount: ICollectionMoney;
+    status: PaymentPlanInstallmentStatus;
+    allocations?: IPlannedDebtAllocation[];
+}
+export interface IPaymentPlan extends ICollectionAuditedEntity {
+    portfolioId: string;
+    contactId: string;
+    debtIds: string[];
+    status: PaymentPlanStatus;
+    configurationId?: string;
+    configurationVersion?: number;
+    /** Immutable copy of every value and formula used to calculate this plan. */
+    configurationSnapshot?: IPaymentPlanConfigurationSnapshot;
+    totalAmount: ICollectionMoney;
+    downPayment?: ICollectionMoney;
+    interestConfigurationId?: string;
+    installments: IPaymentPlanInstallment[];
+    activatedAt?: Date;
+    completedAt?: Date;
+    failedAt?: Date;
+    failureReason?: string;
+    failurePolicyId?: string;
+    replacesPlanId?: string;
+    replacedByPlanId?: string;
+    approvedAt?: Date;
+    approvedBy?: string;
+    version: number;
+}
+export interface IPaymentPlanFailurePolicy extends ICollectionAuditedEntity {
+    name: string;
+    enabled: boolean;
+    maximumOverdueInstallments?: number;
+    gracePeriodDays?: number;
+    minimumOverdueAmount?: ICollectionMoney;
+    automaticFailure: boolean;
+    supervisorApprovalRequired: boolean;
+}
+export interface ICreatePaymentPlanDto {
+    portfolioId: string;
+    contactId: string;
+    debtIds: string[];
+    configurationId?: string;
+    installmentCount?: number;
+    firstDueAt?: Date;
+    frequency?: PaymentPlanFrequency;
+    customDueDates?: Date[];
+    totalAmount: ICollectionMoney;
+    downPayment?: ICollectionMoney;
+    interestConfigurationId?: string;
+    /** Optional for formula-generated plans; required for manually constructed plans. */
+    installments?: Omit<IPaymentPlanInstallment, 'id' | 'paidAmount' | 'status'>[];
+    replacesPlanId?: string;
+    source?: string;
+    idempotencyKey?: string;
+}

package/dist/Collections/PaymentPlan.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PaymentPlanInstallmentStatus = exports.PaymentPlanStatus = void 0;
+var PaymentPlanStatus;
+(function (PaymentPlanStatus) {
+    PaymentPlanStatus["DRAFT"] = "DRAFT";
+    PaymentPlanStatus["PENDING_APPROVAL"] = "PENDING_APPROVAL";
+    PaymentPlanStatus["ACTIVE"] = "ACTIVE";
+    PaymentPlanStatus["COMPLETED"] = "COMPLETED";
+    PaymentPlanStatus["FAILED"] = "FAILED";
+    PaymentPlanStatus["CANCELLED"] = "CANCELLED";
+    PaymentPlanStatus["REFINANCED"] = "REFINANCED";
+})(PaymentPlanStatus || (exports.PaymentPlanStatus = PaymentPlanStatus = {}));
+var PaymentPlanInstallmentStatus;
+(function (PaymentPlanInstallmentStatus) {
+    PaymentPlanInstallmentStatus["PENDING"] = "PENDING";
+    PaymentPlanInstallmentStatus["PARTIALLY_PAID"] = "PARTIALLY_PAID";
+    PaymentPlanInstallmentStatus["PAID"] = "PAID";
+    PaymentPlanInstallmentStatus["OVERDUE"] = "OVERDUE";
+    PaymentPlanInstallmentStatus["CANCELLED"] = "CANCELLED";
+})(PaymentPlanInstallmentStatus || (exports.PaymentPlanInstallmentStatus = PaymentPlanInstallmentStatus = {}));